Procedures.md

Checklists for various maintenance tasks

Creating a release

• Update CHANGELOG.md with the major changes since the last release
• Update the helm chart template
  • In Chart.yaml, update version, appVersion, and annotations.artifacthub.io/changes
  • Also update the annotation for the signing key if necessary (annotations.artifacthub.io/signKey)
• Create a PR w/ the above and commit to main
• Branch to release-X.Y
• Tag the release: vX.Y.Z
• Ensure tagged container images become available on Quay for all containers

Release the updated Helm chart

• Package the chart:
  $ helm package helm/volsync
• Sign the chart (uses the GPG Helm plugin):
  $ helm gpg sign volsync-X.Y.Z.tgz
• Add these files to the backube/helm-charts repo:
  cd ../helm-charts
./build-index ../volsync/volsync-X.Y.Z.tgz
• Create a PR against that repo w/ the changes

Updating tool/dependency versions

• Go
  • Change the version number in operator.yml
  • Change the version number in go.mod
  • Change the version number for the builder images in
    • Dockerfile
    • mover-rclone/Dockerfile
    • mover-restic/Dockerfile
  • Update the OpenShift CI builder images & image substitution rules
• golangci-lint
  • Change the version number in Makefile
  • Check for added/deprecated linters and adjust .golangci.yml as necessary
• Helm
  • Change the version number in Makefile
• Kind
  • Change the version number in operator.yml
• Kuttl
  • Change the version number in Makefile
• operator-sdk
  • Change the version number in Makefile
  • Follow the upgrade guide as appropriate
• Rclone
  • Change the version number in mover-rclone/Dockerfile and update GIT hash to match
• Restic
  • Change the version number in mover-restic/Dockerfile, and update GIT hash to match