From 5e507db65d7e8876f92ead1e4b5f072c43bc1f83 Mon Sep 17 00:00:00 2001 From: thepetk Date: Fri, 11 Aug 2023 12:09:38 +0100 Subject: [PATCH 1/4] Update contributing guide for sample multiple versions Signed-off-by: thepetk --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07514548..94539b2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,6 +88,45 @@ The devfile samples used in this devfile registry are stored in the `extraDevfil 4) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. 5) Open a pull request against this repository with your changes. +### Adding a new version + +In case you want to add another version to a new devfile sample you can update the existing sample inside the `extraDevfileEntries.yaml` file: + +1) Verify your Sample functions with Che. + + - Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. + +2) Open `extraDevfileEntries.yaml` in an editor +3) A sample with multiple versions should be: + + ```yaml + - name: + displayName: + description: + icon: + tags: ["comma", "separated", "list", "of", "tags"] + projectType: + language: + versions: + - version: + schemaVersion: + git: + checkoutFrom: + revision: + remotes: + origin: + - version: + schemaVersion: + git: + checkoutFrom: + revision: + remotes: + origin: + ``` + +4) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. +5) Open a pull request against this repository with your changes. + ### Updating To update a sample: From 6f3a824d380a05bbf6c0d435e39a52480e741dd3 Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Wed, 23 Aug 2023 12:05:41 +0100 Subject: [PATCH 2/4] Update CONTRIBUTING.md Signed-off-by: thepetk --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94539b2c..b7750a4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,6 +121,8 @@ In case you want to add another version to a new devfile sample you can update t checkoutFrom: revision: remotes: + # Note that it is also possible to use different repos + # for each version of a sample. origin: ``` From 3b11f364788b3f7357b477c5d6d88218d5dad564 Mon Sep 17 00:00:00 2001 From: thepetk Date: Thu, 21 Sep 2023 16:28:49 +0100 Subject: [PATCH 3/4] Update contributing guide with rhtap and console steps Signed-off-by: thepetk --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7750a4c..ec36410f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,8 +69,16 @@ The devfile samples used in this devfile registry are stored in the `extraDevfil - Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. -2) Open `extraDevfileEntries.yaml` in an editor -3) Add an entry to the file with the following required fields: +2) Verifying your Sample functions with OpenShift Console + + - Use the Developer perspective and import the Devfile Sample using Import from Git. + +3) Verifying your Sample functions with RHTAP + + - Create an application by importing the sample from Git. + +4) Open `extraDevfileEntries.yaml` in an editor +5) Add an entry to the file with the following required fields: ```yaml - name: @@ -85,8 +93,8 @@ The devfile samples used in this devfile registry are stored in the `extraDevfil origin: ``` -4) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. -5) Open a pull request against this repository with your changes. +6) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. +7) Open a pull request against this repository with your changes. ### Adding a new version @@ -96,8 +104,16 @@ In case you want to add another version to a new devfile sample you can update t - Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. -2) Open `extraDevfileEntries.yaml` in an editor -3) A sample with multiple versions should be: +2) Verifying your Sample functions with OpenShift Console + + - Use the Developer perspective and import the Devfile Sample using Import from Git. + +3) Verifying your Sample functions with RHTAP + + - Create an application by importing the sample from Git. + +4) Open `extraDevfileEntries.yaml` in an editor +5) A sample with multiple versions should be: ```yaml - name: @@ -126,8 +142,8 @@ In case you want to add another version to a new devfile sample you can update t origin: ``` -4) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. -5) Open a pull request against this repository with your changes. +6) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. +7) Open a pull request against this repository with your changes. ### Updating From 6acd5c03050f24632ca6e1c9da45f42735a7b6a6 Mon Sep 17 00:00:00 2001 From: thepetk Date: Thu, 21 Sep 2023 17:27:41 +0100 Subject: [PATCH 4/4] Remove sample step1 from contributing guide Signed-off-by: thepetk --- CONTRIBUTING.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec36410f..ae0e70af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,20 +65,16 @@ Updating an existing devfile stack is relatively straightforward: The devfile samples used in this devfile registry are stored in the `extraDevfileEntries.yaml` file in the root of the repository. To add a devfile sample: -1) Verify your Sample functions with Che. - - - Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. - -2) Verifying your Sample functions with OpenShift Console +1) Verifying your Sample functions with OpenShift Console - Use the Developer perspective and import the Devfile Sample using Import from Git. -3) Verifying your Sample functions with RHTAP +2) Verifying your Sample functions with RHTAP - Create an application by importing the sample from Git. -4) Open `extraDevfileEntries.yaml` in an editor -5) Add an entry to the file with the following required fields: +3) Open `extraDevfileEntries.yaml` in an editor +4) Add an entry to the file with the following required fields: ```yaml - name: @@ -93,27 +89,23 @@ The devfile samples used in this devfile registry are stored in the `extraDevfil origin: ``` -6) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. -7) Open a pull request against this repository with your changes. +5) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. +6) Open a pull request against this repository with your changes. ### Adding a new version In case you want to add another version to a new devfile sample you can update the existing sample inside the `extraDevfileEntries.yaml` file: -1) Verify your Sample functions with Che. - - - Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. - -2) Verifying your Sample functions with OpenShift Console +1) Verifying your Sample functions with OpenShift Console - Use the Developer perspective and import the Devfile Sample using Import from Git. -3) Verifying your Sample functions with RHTAP +2) Verifying your Sample functions with RHTAP - Create an application by importing the sample from Git. -4) Open `extraDevfileEntries.yaml` in an editor -5) A sample with multiple versions should be: +3) Open `extraDevfileEntries.yaml` in an editor +4) A sample with multiple versions should be: ```yaml - name: @@ -142,8 +134,8 @@ In case you want to add another version to a new devfile sample you can update t origin: ``` -6) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. -7) Open a pull request against this repository with your changes. +5) Fill in the fields in the angle brackets based on your sample. Note that there must be only one git remote for the devfile sample. +6) Open a pull request against this repository with your changes. ### Updating