From f2f364ecfff66e39dcd782cd44cb7c492c8b78f1 Mon Sep 17 00:00:00 2001 From: Steven Crespo Date: Wed, 30 Jun 2021 09:46:47 -0700 Subject: [PATCH] Add make charts step to README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d47b9641a..3488bca22 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ the auto-generated `charts` directory. If this is a new chart, set the `kubeVersion` field and add the required annotations in `packages/{CHART_NAME}/charts/Chart.yaml`: ```yaml -kubeVersion: # A SemVer range of compatible Kubernetes versions. E.g 1.18 - 1.21, >= 1.19, etc +kubeVersion: # A SemVer range of compatible Kubernetes versions. E.g "1.18 - 1.21", ">= 1.19", etc annotations: catalog.cattle.io/certified: partner # Enables the "partner" badge in the UI for easier identification catalog.cattle.io/release-name: chart-name-here # Your chart's name in kebab-case, this is used for deployment @@ -238,4 +238,11 @@ export PACKAGE={CHART_NAME} # Only need to run once make clean ``` -Ensure that you've already saved your changes with `PACKAGE={CHART_NAME} make patch` and cleaned up your working directory with `PACKAGE={CHART_NAME} make clean`. Then, commit all the remaining changes to `packages/{CHART_NAME}` and submit your PR to the branch `main-source`. \ No newline at end of file +Ensure that you've already saved your changes with `PACKAGE={CHART_NAME} make patch` and cleaned up your working directory with `PACKAGE={CHART_NAME} make clean`. Then, commit all the remaining changes to `packages/{CHART_NAME}`. + +Once you've committed all your changes in your package directory, run `make charts` and add everything that gets updated to a second commit (Usually `assets`, `charts` and in some cases `index.yaml` as well) so that your Pull Request contents are as following: + + 1st commit: Changes in package to add or update your chart + 2nd commit: Result of running `make charts` + +You are now ready to submit a Pull Request to the `main-source` branch for review.