diff --git a/README.md b/README.md index 8e0c40f..3aae524 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,32 @@ Then run the following to see a list of available charts: ```sh helm search repo qpoint ``` + +## Releasing a new version + +1. Create a PR that updates `Chart.yaml`'s version numbers. + +```yaml +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.0.18 # 🚨 Update this version number + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "v0.5.14" # 🚨 Update this version number +``` + +2. Merge the PR. + +3. Pull the latest `main` branch and release the chart. + +4. Create a new branch for the next version. + +5. Run the `./bin/update-index` script to update the index.yaml file. + +6. Submit a PR with the updated index.yaml file and merge it. + +7. Done! 🎉 \ No newline at end of file