Skip to content

Latest commit

 

History

History
103 lines (94 loc) · 6.51 KB

RELEASE.md

File metadata and controls

103 lines (94 loc) · 6.51 KB
Raw

How To Release

This repo contains two helm charts: cloudnative-pg and cnpg-sandbox. Both the charts are available through a single repository, but should be released separately as their versioning might be unlinked, and the latter depends on the former.

IMPORTANT we should run the below procedures against the latest point release of the CloudNativePG operator. I.e. even if we have several release branches in CNPG, we will only target the most advanced point release (e.g. 1.17.1)

How to release cloudnative-pg

In order to create a new release of the cloudnative-pg chart, follow these steps:

  1. take note of the current value of the release: see .version in charts/cloudnative-pg/Chart.yaml
  2. decide which version to create, depending on the kind of jump of the CloudNativePG release, following semver semantics. For this document, let's call it X.Y.Z
  3. create a branch named release/cloudnative-pg-vX.Y.Z and switch to it
  4. update the .version in the Chart.yaml file to "X.Y.Z"
  5. update everything else as required, e.g. if releasing due to a new cloudnative-pg version being released, you might want to update the following:
    1. .appVersion in the Chart.yaml file
    2. crds.yaml, whose content can be built using kustomize from the cloudnative-pg repo using kustomize remoteBuild running: kustomize build https://github.com/cloudnative-pg/cloudnative-pg/tree/release-1.16/config/helm/\?ref=v1.16.0, take care to set the correct release branch and version as ref (v1.15.1 in the example command).
      It might be easier to run kustomize build config/helm from the cloudnative-pg repo, with the desired release branch checked out, and copy the result to ./charts/cloudnative-pg/templates/crds/crds.yaml.
    3. NOTE: please keep the guards for .Values.crds.create, i.e. {{- if .Values.crds.create }} and {{- end }} after you copy the CRD into templates/crds/crds.yaml.
    4. to update the files in the templates directory, you can diff the previous CNPG release yaml against the new one, to find what should be updated (e.g. vimdiff https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.15.0.yaml https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.15.1.yaml)
      Or, from the cloudnative-pg repo, with the desired release branch checked out, vimdiff releases/cnpg-1.15.0.yaml releases/cnpg-1.15.1.yaml
    5. update values.yaml if needed
    6. NOTE: updating values.yaml just for the CNPG verision may not be necessary, as the value should default to the appVersion in Chart.yaml
  6. run make docs schema to regenerate the docs and the values schema in case it is needed
  7. git commit -S -s -m "Release cloudnative-pg-vX.Y.Z" --edit and add all the informations you wish below the commit message.
  8. git push --set-upstream origin release/coudnative-pg-vX.Y.Z
  9. a PR named Release cloudnative-pg-vX.Y.Z will 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 cloudnative-pg-vX.Y.Z
  13. a tag cloudnative-pg-vX.Y.Z will be automatically created by an action, which will ten trigger the release action, check they both are successful.
  14. once done you should be able to run helm repo helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg and be able to see the new version vX.Y.Z as CHART VERSION for cloudnative-pg

How to release cnpg-sandbox

cnpg-sandbox is an umbrella chart which depends on the cloudnative-pg chart, therefore in case the only change required is bumping cloudnative-pg version, its release should be done only once its dependency has been successfully released.

In order to create a new release of the cnpg-sandbox chart, follow these steps:

  1. take note of the current value of the release: see .version in charts/cnpg-sandbox/Chart.yaml
  2. decide which version to create, depending on the kind of jump of the cloudnative-pg chart release, following semver semantics. For this document, let's call it X.Y.Z
  3. create a branch release/cnpg-sandbox-vX.Y.Z and switch to it
  4. update the .version in the Chart.yaml file to "X.Y.Z"
  5. update everything else as required, e.g. if releasing due to a new cloudnative-pg chart being released:
  6. bump the .appVersion in Chart.yaml
  7. bump .dependecies[0].version for the cloudnative-pg chart in the aforementioned Chart.yaml file
  8. update the values.yaml file if needed
  9. run helm dependency update charts/cnpg-sandbox to sync the Chart.lock to the new dependencies
  10. run make docs schema to regenerate the docs and the values schema in case it is needed
  11. git commit -S -s -m "Release cnpg-sandbox-vX.Y.Z" --edit and add all the informations you wish below the commit message.
  12. git push --set-upstream origin release/cnpg-sandbox-vX.Y.Z
  13. a PR named Release cnpg-sandbox-vX.Y.Z will be automatically created
  14. wait for all the checks to pass
  15. 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.
  16. merge the pr squashing all commits and taking care to keep the commit message to be Release cnpg-sandbox-vX.Y.Z
  17. a tag cnpg-sandbox-vX.Y.Z will be automatically created by an action, which will ten trigger the release action, check they both are successful.
  18. once done you should be able to run helm repo helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg and be able to see the new version vX.Y.Z as CHART VERSION for cnpg-sandbox