Skip to content

Commit beecb12

Browse files
authored
Update the registry stack PR review process (#384)
* 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>
1 parent 30d01c4 commit beecb12

File tree

19 files changed

+69
-107
lines changed

19 files changed

+69
-107
lines changed

.github/CODEOWNERS

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,53 @@
1-
# Devfile owned stacks
2-
/stacks/nodejs-angular/ @devfile/devfile-services-team
3-
/stacks/python-django/ @devfile/devfile-services-team
4-
/stacks/go/ @devfile/devfile-services-team
5-
/stacks/php-laravel/ @devfile/devfile-services-team
6-
/stacks/nodejs-nextjs/ @devfile/devfile-services-team
7-
/stacks/nodejs-nuxtjs/ @devfile/devfile-services-team
8-
/stacks/python/ @devfile/devfile-services-team
9-
/stacks/nodejs-react/ @devfile/devfile-services-team
10-
/stacks/nodejs-svelte/ @devfile/devfile-services-team
11-
/stacks/nodejs-vue/ @devfile/devfile-services-team
1+
# Global owners:
2+
# The /devfile/devfile-services-team is the global owner for all files in the repo
3+
# unless another mention takes precedence.
4+
* @devfile/devfile-services-team
5+
6+
# Stack owners:
7+
# 1. The devfile/che-team is mentioned as an owner because a review is required
8+
# for every PR that updates stacks.
9+
# 2. As you may notice some stacks are owned by the devfile/devfile-services-team
10+
# directly.
11+
# 3. All the owner mentions follow the format below:
12+
# <path-to-the-stack-dir> @owner @reviwer-team
13+
14+
# .Net stacks
15+
/stacks/dotnet50/ @kadel @devfile/che-team
16+
/stacks/dotnet60/ @kadel @devfile/che-team
17+
/stacks/dotnetcore31/ @kadel @devfile/che-team
18+
19+
# Golang stacks
20+
/stacks/go/ @devfile/devfile-services-team @devfile/che-team
21+
22+
# Java stacks
23+
/stacks/java-maven/ @kadel @devfile/che-team
24+
/stacks/java-openliberty/ @kadel @devfile/che-team
25+
/stacks/java-openliberty-gradle/ @ajm01 @devfile/che-team
26+
/stacks/java-quarkus/ @maxandersen @devfile/che-team
27+
/stacks/java-springboot/ @kadel @devfile/che-team
28+
/stacks/java-vertx/ @kadel @devfile/che-team
29+
/stacks/java-websphereliberty/ @ajm01 @devfile/che-team
30+
/stacks/java-websphereliberty-gradle/ @ajm01 @devfile/che-team
31+
/stacks/java-wildfly/ @ehsavoie @devfile/che-team
32+
/stacks/java-wildfly-bootable-jar/ @ehsavoie @devfile/che-team
33+
34+
# Node.js stacks
35+
/stacks/nodejs/ @BethGriggs @devfile/che-team
36+
/stacks/nodejs-angular/ @devfile/devfile-services-team @devfile/che-team
37+
/stacks/nodejs-nextjs/ @devfile/devfile-services-team @devfile/che-team
38+
/stacks/nodejs-nuxtjs/ @devfile/devfile-services-team @devfile/che-team
39+
/stacks/nodejs-react/ @devfile/devfile-services-team @devfile/che-team
40+
/stacks/nodejs-svelte/ @devfile/devfile-services-team @devfile/che-team
41+
/stacks/nodejs-vue/ @devfile/devfile-services-team @devfile/che-team
42+
43+
# PHP stacks
44+
/stacks/php-laravel/ @devfile/devfile-services-team @devfile/che-team
45+
46+
# Python stacks
47+
/stacks/python/ @devfile/devfile-services-team @devfile/che-team
48+
/stacks/python-django/ @devfile/devfile-services-team @devfile/che-team
49+
50+
# Other stacks
51+
# *The udi stack has two owners
52+
/stacks/udi @ibuziuk @l0rd @devfile/che-team
53+
/stacks/ollama @ibuziuk @manhah @devfile/che-team

CONTRIBUTING.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,19 @@ Updating an existing devfile stack is relatively straightforward:
6565
- 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.
6666
4) Test your changes:
6767

68-
- 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.
68+
- 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.
6969
5) Open a pull request against this repository with your changes.
7070

71+
### Registry Stack Review Process
72+
73+
For every PR, containing updates for registry stacks the review process is:
74+
75+
* All CODEOWNERS related with the stack are requested to provide their review.
76+
* The PR should be first approved from the stack owner & one eclipse che team member.
77+
* A devfile-services team member should confirm that the PR has the required reviews and if yes, merge it.
78+
79+
For more informations about stack owners please take a look at the [CODEOWNERS](./.github/CODEOWNERS) file.
80+
7181
### Automatic Stack Image Update
7282

7383
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`.
@@ -159,19 +169,19 @@ To update a sample:
159169
3) Make the necessary changes.
160170
4) Open a pull request against this repository with your changes.
161171

162-
### How to Test Changes
172+
## How to Test Changes
163173

164-
#### Odo
174+
### Odo
165175

166176
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.
167177

168178
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.
169179

170-
#### Che
180+
### Che
171181

172-
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.
182+
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.
173183

174-
#### Console
184+
### Console
175185

176186
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.
177187
Note: Currently Console only works with devfile v2.2.0 samples with outer loop support.

stacks/OWNERS

Lines changed: 0 additions & 24 deletions
This file was deleted.

stacks/dotnet50/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/dotnet60/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/dotnetcore31/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/java-maven/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/java-openliberty-gradle/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/java-openliberty/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

stacks/java-quarkus/OWNERS

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)