From b07353c2a90fa32711dc218fecbcf8bafb9a9a0e Mon Sep 17 00:00:00 2001 From: Nefi Munoz Date: Fri, 13 Jan 2023 08:04:23 -0700 Subject: [PATCH 1/2] Change to suggest creating separate branch --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index beaea54f8..ae2959f55 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ files on top of it. ## Workflow -#### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository +#### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository, clone your fork, checkout the **main-source** branch and pull the latest changes. Then create a new branch off of main-source #### 2. Clone your fork and ensure the main-source branch is checked out ```bash git clone -b main-source git@github.com:/partner-charts.git @@ -71,12 +71,12 @@ git add packages/suse/kubewarden-controller git commit -m "Submitting suse/kubewarden-controller" ``` #### 7. [Test your configuration](#testing-your-configuration) -#### 8. Push your commit and open a pull request +#### 8. Push your commit ```bash -git push origin main-source - -# Open Your Pull Request +git push origin ``` +#### 9. Open a pull request to **main-source** branch + ## Testing your configuration If you would like to test your configuration using the CI tool, simply run the provided script in `scripts/pull-ci-scripts` to download the binary. The 'auto' function is what will be run to download and store your chart. From 51e6de8656c708260192874b84dfb9cfd0ed102f Mon Sep 17 00:00:00 2001 From: Nefi Munoz Date: Fri, 13 Jan 2023 08:08:32 -0700 Subject: [PATCH 2/2] Removed step that got combined --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ae2959f55..c312fc10f 100644 --- a/README.md +++ b/README.md @@ -36,17 +36,14 @@ files on top of it. ## Workflow #### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository, clone your fork, checkout the **main-source** branch and pull the latest changes. Then create a new branch off of main-source -#### 2. Clone your fork and ensure the main-source branch is checked out -```bash -git clone -b main-source git@github.com:/partner-charts.git -``` -#### 3. Create subdirectories in **packages** in the form of `/` + +#### 2. Create subdirectories in **packages** in the form of `/` ```bash cd partner-charts mkdir -p packages/suse/kubewarden-controller ``` -#### 4. Create your [upstream.yaml](#configuration-file) +#### 3. Create your [upstream.yaml](#configuration-file) Some [examples](#examples) are provided below ```bash cat < packages/suse/kubewarden-controller/upstream.yaml @@ -59,23 +56,23 @@ ChartMetadata: icon: https://www.kubewarden.io/images/icon-kubewarden.svg EOF ``` -#### 5. [Create 'overlay' files](#overlay) +#### 4. [Create 'overlay' files](#overlay) Create any add-on files such as an app-readme.md and questions.yaml in an 'overlay' subdirectory (Optional) ```bash mkdir packages/suse/kubewarden-controller/overlay echo "Example app-readme.md" > packages/suse/kubewarden-controller/overlay/app-readme.md ``` -#### 6. Commit your packages directory +#### 5. Commit your packages directory ```bash git add packages/suse/kubewarden-controller git commit -m "Submitting suse/kubewarden-controller" ``` -#### 7. [Test your configuration](#testing-your-configuration) -#### 8. Push your commit +#### 6. [Test your configuration](#testing-your-configuration) +#### 7. Push your commit ```bash git push origin ``` -#### 9. Open a pull request to **main-source** branch +#### 8. Open a pull request to **main-source** branch ## Testing your configuration