Skip to content

Latest commit

 

History

History
56 lines (53 loc) · 2.19 KB

RELEASE.md

File metadata and controls

56 lines (53 loc) · 2.19 KB

Release Process

In order to create a new release of any chart, follow these steps:

  1. Set the chart name in question

    CHART_NAME="cluster"
  2. Take note of the current value of the release: see .version in charts/$CHART_NAME/Chart.yaml

    yq -r '.version' charts/$CHART_NAME/Chart.yaml
  3. Decide which version to create, depending on the kind of changes and backwards compatibility, following semver semantics. For this document, let's call it X.Y.Z

    NEW_VERSION="X.Y.Z"
  4. Create a branch: named release/$CHART_NAME-vX.Y.Z and switch to it

    git checkout -b release/$CHART_NAME-v$NEW_VERSION
  5. Update the .version in the Chart.yaml file to "X.Y.Z"

    sed -i -E "s/^version: ([0-9]+.?)+/version: $NEW_VERSION/" charts/$CHART_NAME/Chart.yaml
  6. Run make docs schema to regenerate the docs and the values schema in case it is needed

    make docs schema
  7. Commit and add the relevant information you wish in the commit message.

    git add .
    git commit -S -s -m "Release $CHART_NAME-v$NEW_VERSION" --edit
  8. Push the new branch

    git push --set-upstream origin release/$CHART_NAME-v$NEW_VERSION
  9. A PR should be automatically created

  10. Wait for all the checks to pass

  11. Two approvals are required in order to merge the PR, if you are a maintainer approve the PR yourself and ask for another approval, otherwise ask for two approvals directly.

  12. Merge the PR squashing all commits and taking care to keep the commit message to be Release CHART_NAME-vX.Y.Z

  13. A release CHART_NAME-vX.Y.Z should be automatically created which will then trigger the release action. Verify they both are successful.

  14. Once done you should be able to run:

    helm repo add cnpg-grafana https://cloudnative-pg.github.io/grafana-dashboards
    helm repo update
    helm search repo cnpg

    and be able to see the new version X.Y.Z as CHART VERSION for cluster

  15. Update the chart on Grafana.com.