Skip to content

Commit

Permalink
Update the registry stack PR review process (#384)
Browse files Browse the repository at this point in the history
* Update contributing.md

Signed-off-by: thepetk <thepetk@gmail.com>

* Update codeowners file

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove all OWNERS files

Signed-off-by: thepetk <thepetk@gmail.com>

* Revert revert root owners deletion

Signed-off-by: thepetk <thepetk@gmail.com>

* Update CODEOWNERS file

Signed-off-by: thepetk <thepetk@gmail.com>

* Add new line to CODEOWNERS

Signed-off-by: thepetk <thepetk@gmail.com>

* Update contributing guide

Signed-off-by: thepetk <thepetk@gmail.com>

* Update CONTRIBUTING.md

SIgned-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>
  • Loading branch information
thepetk committed May 14, 2024
1 parent 30d01c4 commit beecb12
Show file tree
Hide file tree
Showing 19 changed files with 69 additions and 107 deletions.
64 changes: 53 additions & 11 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
# Devfile owned stacks
/stacks/nodejs-angular/ @devfile/devfile-services-team
/stacks/python-django/ @devfile/devfile-services-team
/stacks/go/ @devfile/devfile-services-team
/stacks/php-laravel/ @devfile/devfile-services-team
/stacks/nodejs-nextjs/ @devfile/devfile-services-team
/stacks/nodejs-nuxtjs/ @devfile/devfile-services-team
/stacks/python/ @devfile/devfile-services-team
/stacks/nodejs-react/ @devfile/devfile-services-team
/stacks/nodejs-svelte/ @devfile/devfile-services-team
/stacks/nodejs-vue/ @devfile/devfile-services-team
# Global owners:
# The /devfile/devfile-services-team is the global owner for all files in the repo
# unless another mention takes precedence.
* @devfile/devfile-services-team

# Stack owners:
# 1. The devfile/che-team is mentioned as an owner because a review is required
# for every PR that updates stacks.
# 2. As you may notice some stacks are owned by the devfile/devfile-services-team
# directly.
# 3. All the owner mentions follow the format below:
# <path-to-the-stack-dir> @owner @reviwer-team

# .Net stacks
/stacks/dotnet50/ @kadel @devfile/che-team
/stacks/dotnet60/ @kadel @devfile/che-team
/stacks/dotnetcore31/ @kadel @devfile/che-team

# Golang stacks
/stacks/go/ @devfile/devfile-services-team @devfile/che-team

# Java stacks
/stacks/java-maven/ @kadel @devfile/che-team
/stacks/java-openliberty/ @kadel @devfile/che-team
/stacks/java-openliberty-gradle/ @ajm01 @devfile/che-team
/stacks/java-quarkus/ @maxandersen @devfile/che-team
/stacks/java-springboot/ @kadel @devfile/che-team
/stacks/java-vertx/ @kadel @devfile/che-team
/stacks/java-websphereliberty/ @ajm01 @devfile/che-team
/stacks/java-websphereliberty-gradle/ @ajm01 @devfile/che-team
/stacks/java-wildfly/ @ehsavoie @devfile/che-team
/stacks/java-wildfly-bootable-jar/ @ehsavoie @devfile/che-team

# Node.js stacks
/stacks/nodejs/ @BethGriggs @devfile/che-team
/stacks/nodejs-angular/ @devfile/devfile-services-team @devfile/che-team
/stacks/nodejs-nextjs/ @devfile/devfile-services-team @devfile/che-team
/stacks/nodejs-nuxtjs/ @devfile/devfile-services-team @devfile/che-team
/stacks/nodejs-react/ @devfile/devfile-services-team @devfile/che-team
/stacks/nodejs-svelte/ @devfile/devfile-services-team @devfile/che-team
/stacks/nodejs-vue/ @devfile/devfile-services-team @devfile/che-team

# PHP stacks
/stacks/php-laravel/ @devfile/devfile-services-team @devfile/che-team

# Python stacks
/stacks/python/ @devfile/devfile-services-team @devfile/che-team
/stacks/python-django/ @devfile/devfile-services-team @devfile/che-team

# Other stacks
# *The udi stack has two owners
/stacks/udi @ibuziuk @l0rd @devfile/che-team
/stacks/ollama @ibuziuk @manhah @devfile/che-team
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,19 @@ Updating an existing devfile stack is relatively straightforward:
- When updating a stack with a newer version of the devfile specification (e.g., 2.1.0 -> 2.2.0), the previous version of the stack **must** be kept for a minimum of one (1) year.
4) Test your changes:

- Minimally, testing with odo v2 (`odo create`, `odo push`, etc) and odo v3 (`odo init`, `odo dev`, etc) is recommended, however if your Devfile is used with other tools, it's recommended to test there as well.
- Minimally, testing with odo v2 (`odo create`, `odo push`, etc), odo v3 (`odo init`, `odo dev`, etc) and che (see [How to Test Changes > Che](https://github.com/devfile/registry/blob/main/CONTRIBUTING.md#che)) is recommended, however if your Devfile is used with other tools, it's recommended to test there as well.
5) Open a pull request against this repository with your changes.

### Registry Stack Review Process

For every PR, containing updates for registry stacks the review process is:

* All CODEOWNERS related with the stack are requested to provide their review.
* The PR should be first approved from the stack owner & one eclipse che team member.
* A devfile-services team member should confirm that the PR has the required reviews and if yes, merge it.

For more informations about stack owners please take a look at the [CODEOWNERS](./.github/CODEOWNERS) file.

### Automatic Stack Image Update

As images used inside the stacks need to be up-to-date and in order to avoid using the `latest` tag, the renovate bot runs periodically ensuring that all images used from stacks (for example, inside components) have the latest version. As a result, all images used inside a devfile of a stack need to have a fixed version (e.g `1.1.0`) instead of `latest`.
Expand Down Expand Up @@ -159,19 +169,19 @@ To update a sample:
3) Make the necessary changes.
4) Open a pull request against this repository with your changes.

### How to Test Changes
## How to Test Changes

#### Odo
### Odo

odo v2: `odo create` and `odo push` to test devfile changes. See [odo v2 Doc](https://odo.dev/docs/2.5.0/using-odo/create-component) for more details.

odo V3: `odo init` and `odo dev` to test devfile changes. See [odo v3 Doc](https://odo.dev/docs/command-reference/init) for more details.

#### Che
### Che

Opening the URL `https://workspaces.openshift.com/#<repository_url>` in your browser should start a workspace where `exec` commands run successfully. Type `task+<space>` in the IDE command palette to see the list of available commands.
Opening the URL https://workspaces.openshift.com/#<repository_url> in your browser should start a workspace where exec commands run successfully. Type `task devfile` and press the `Enter` key in the IDE command palette to see the list of available devfile commands. Then, run all devfile commands one by one, to ensure they are executed successfully.

#### Console
### Console

In developer view, create an application via `Import from Git`. Provide git repository Url and verify if the application can be built and ran successfully.
Note: Currently Console only works with devfile v2.2.0 samples with outer loop support.
24 changes: 0 additions & 24 deletions stacks/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/dotnet50/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/dotnet60/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/dotnetcore31/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-maven/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-openliberty-gradle/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-openliberty/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-quarkus/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-springboot/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-vertx/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-websphereliberty-gradle/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-websphereliberty/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-wildfly-bootable-jar/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/java-wildfly/OWNERS

This file was deleted.

4 changes: 0 additions & 4 deletions stacks/nodejs/OWNERS

This file was deleted.

5 changes: 0 additions & 5 deletions stacks/ollama/OWNERS

This file was deleted.

5 changes: 0 additions & 5 deletions stacks/udi/OWNERS

This file was deleted.

0 comments on commit beecb12

Please sign in to comment.