Skip to content

RELEASE.md

Latest commit

 

History

History
258 lines (192 loc) · 10.6 KB

RELEASE.md

File metadata and controls

258 lines (192 loc) · 10.6 KB

Release Process

This repo contains two helm charts: edb-postgres-for-kubernetes and edb-postgres-distributed-for-kubernetes. 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 each EDB operator. I.e., even if we have several supported release branches, we will only target the most advanced point release.

Charts

  1. Releasing the edb-postgres-for-kubernetes chart
  2. Releasing the edb-postgres-distributed-for-kubernetes chart

Releasing the edb-postgres-for-kubernetes chart

To create a new release of the edb-postgres-for-kubernetes chart, follow these steps:

  1. Check the current chart version by inspecting the version field in charts/edb-postgres-for-kubernetes/Chart.yaml.

    OLD_VERSION=$(yq -r '.version' charts/edb-postgres-for-kubernetes/Chart.yaml)
OLD_PG4K_VERSION=$(yq -r '.appVersion' charts/edb-postgres-for-kubernetes/Chart.yaml)
echo $OLD_VERSION

  2. Determine the next chart version based on the type of update in the EDB Postgres for Kubernetes (PG4K) release, following semantic versioning best practices. For reference, use X.Y.Z as the new version.

    NEW_VERSION="X.Y.Z"

  3. Create a branch named release/edb-postgres-for-kubernetes-vX.Y.Z and switch to it

    git switch --create release/edb-postgres-for-kubernetes-v$NEW_VERSION

  4. Update the .version in charts/edb-postgres-for-kubernetes/Chart.yaml to "X.Y.Z"

    sed -i -E "s/^version: \"([0-9]+.?)+\"/version: \"$NEW_VERSION\"/" charts/edb-postgres-for-kubernetes/Chart.yaml

  5. Update everything else as required, if releasing due to a new edb-postgres-for-kubernetes version being released, you might want to:

    1. Find the latest edb-postgres-for-kubernetes version by running:

      NEW_PG4K_VERSION=$(
  gh api "https://api.github.com/repos/EnterpriseDB/cloud-native-postgres/tags" | \
  jq -r '.[0].name | ltrimstr("v")')
echo $NEW_PG4K_VERSION

    2. Update .appVersion in Chart.yaml file

      sed -i -E "s/^appVersion: \"([0-9]+.?)+\"/appVersion: \"$NEW_PG4K_VERSION\"/" \
  charts/edb-postgres-for-kubernetes/Chart.yaml

    3. Update crds.yaml, which can be built using kustomize from the PG4K repo using kustomize remoteBuild running:

      echo '{{- if .Values.crds.create }}' > ./charts/edb-postgres-for-kubernetes/templates/crds/crds.yaml
kustomize build https://github.com/EnterpriseDB/cloud-native-postgres/config/helm/\?ref\=v$NEW_PG4K_VERSION >> ./charts/edb-postgres-for-kubernetes/templates/crds/crds.yaml
echo '{{- end }}' >> ./charts/edb-postgres-for-kubernetes/templates/crds/crds.yaml

    4. To update the files in the templates directory, you can diff the previous PG4K release YAML against the new one to find what should be updated. E.g.,

      vimdiff \
  "https://get.enterprisedb.io/pg4k/pg4k-${OLD_PG4K_VERSION}.yaml" \
  "https://get.enterprisedb.io/pg4k/pg4k-${NEW_PG4K_VERSION}.yaml"

      Or from the cloudnative-pg repo, with the desired release branch checked out:

      vimdiff pg4k-${OLD_PG4K_VERSION}.yaml pg4k-${NEW_PG4K_VERSION}.yaml

    5. Update values.yaml if needed

      NOTE: updating values.yaml just for the PG4K version is not 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 as needed

    make docs schema

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

    git add -p .
git commit -S -s -m "Release edb-postgres-for-kubernetes-v$NEW_VERSION" --edit

  8. Push the new branch

    git push --set-upstream origin release/edb-postgres-for-kubernetes-v$NEW_VERSION

  9. A PR named Release edb-postgres-for-kubernetes-vX.Y.Z should be automatically created

  10. Wait for all the checks to pass

  11. Two approvals are required to merge the PR. If you are a maintainer, you may approve the PR yourself and request an additional approval from another maintainer. Otherwise, request two approvals from maintainers.

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

  13. A release edb-postgres-for-kubernetes-vX.Y.Z should be automatically created by an action, which will then trigger the release action. Verify they both are successful.

  14. Once done, you should be able to run:

    helm repo add edb https://enterprisedb.github.io/edb-postgres-for-kubernetes-charts
helm repo update
helm search repo edb

    and be able to see the new version X.Y.Z as CHART VERSION for edb-postgres-for-kubernetes

Releasing the edb-postgres-distributed-for-kubernetes chart

To create a new release of the edb-postgres-distributed-for-kubernetes chart, follow these steps:

  1. Check the current chart version by inspecting the version field in charts/edb-postgres-distributed-for-kubernetes/Chart.yaml

    OLD_VERSION=$(yq -r '.version' charts/edb-postgres-distributed-for-kubernetes/Chart.yaml)
OLD_PGD4K_VERSION=$(yq -r '.appVersion' charts/edb-postgres-distributed-for-kubernetes/Chart.yaml)
echo $OLD_VERSION

  2. Determine the next chart version based on the type of update in the EDB Postgres Distributed for Kubernetes (PGD4K) release, following semantic versioning best practices. For reference, use X.Y.Z as the new version.

    NEW_VERSION="X.Y.Z"

  3. Create a branch named release/edb-postgres-distributed-for-kubernetes-vX.Y.Z and switch to it

    git switch --create release/edb-postgres-distributed-for-kubernetes-v$NEW_VERSION

  4. Update the .version in charts/edb-postgres-distributed-for-kubernetes/Chart.yaml to "X.Y.Z"

    sed -i -E "s/^version: \"([0-9]+.?)+\"/version: \"$NEW_VERSION\"/" charts/edb-postgres-distributed-for-kubernetes/Chart.yaml

  5. Update everything else as required, if releasing due to a new edb-postgres-distributed-for-kubernetes version being released, you might want to:

    1. Find the latest edb-postgres-distributed-for-kubernetes version by running:

      NEW_PGD4K_VERSION=$(
  gh api "https://api.github.com/repos/EnterpriseDB/pg4k-pgd/tags" | \
  jq -r '.[0].name | ltrimstr("v")')
echo $NEW_PGD4K_VERSION

    2. Update .appVersion in Chart.yaml file

      sed -i -E "s/^appVersion: \"([0-9]+.?)+\"/appVersion: \"$NEW_PGD4K_VERSION\"/" \
  charts/edb-postgres-distributed-for-kubernetes/Chart.yaml

    3. Update crds.yaml, which can be built using kustomize from the PGD4K repo using kustomize remoteBuild running:

      echo '{{- if .Values.crds.create }}' > ./charts/edb-postgres-distributed-for-kubernetes/templates/crds/crds.yaml
kustomize build https://github.com/EnterpriseDB/pg4k-pgd/config/helm/\?ref\=v$NEW_PGD4K_VERSION >> ./charts/edb-postgres-distributed-for-kubernetes/templates/crds/crds.yaml
echo '{{- end }}' >> ./charts/edb-postgres-distributed-for-kubernetes/templates/crds/crds.yaml

    4. To update the files in the templates directory, you can diff the previous PGD4K release YAML against the new one to find what should be updated. E.g.,

      vimdiff \
  "https://get.enterprisedb.io/pg4k-pgd/pg4k-pgd-enterprise-${OLD_PGD4K_VERSION}.yaml" \
  "https://get.enterprisedb.io/pg4k-pgd/pg4k-pgd-enterprise-${NEW_PGD4K_VERSION}.yaml"

      Or from the pg4k-pgd repo, with the desired release branch checked out:

      vimdiff ./releases/pg4k-pgd-enterprise-${OLD_PGD4K_VERSION}.yaml ./releases/pg4k-pgd-enterprise-${NEW_PGD4K_VERSION}.yaml

    5. Update values.yaml if needed

      NOTE: updating values.yaml just for the PGD4K version (imageTag attribute) is not necessary, as the value should default to the appVersion in Chart.yaml

    6. Update pgdImageName and proxyImageName defaults inside values.yaml according to the default versions present in the release.

    7. Update dependent cert-manager version in Chart.yaml if needed

    8. Update the .appVersion and .version in subchart edb-postgres-for-kubernetes-lts and follow the PG4K Release to update the subchart to latest PG4K lts release if needed

    9. Update dependent edb-postgres-for-kubernetes-lts version in Chart.yaml

  6. From here onward, you can follow the steps of PG4K Release, starting from step 6.

IMPORTANT: Take care to replace edb-postgres-for-kubernetes with edb-postgres-distributed-for-kubernetes accordingly before executing the commands.