From 5aea0143b9d906ffebf306f6a68842efe4e459c3 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Fri, 20 Jan 2023 01:23:56 -0600 Subject: [PATCH] Add blurb about mandatory Chart versioning Signed-off-by: jmeridth Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b805ce3..634e5055 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,10 @@ Any breaking changes to a chart (backwards incompatible) require: * Bump of the current Major version of the chart * State possible manual changes for this chart version in the `Upgrading` section of the chart's `README.md.gotmpl` +### Chart Versioning + +Currently we require a chart version bump for every change to a chart, including updating information for older verions. This may change in the future. + ### Updating a chart README.md When updating the `README.md.gotmpl` inside a chart directory you must to run the `helm-docs` script to generate the updated `README.md` file. To reiterate, you should not edit the `README.md` file manually. It will be generated by the following command: