release-checklist.md

name	about	title	labels	assignees
Release Checklist	Checklist for release kapp-controller		carvel, release

Releasing a new minor / major:

• OSS Release
  • Releasing via workflow.
  • Close any GitHub issues that have been delivered.
  • Add a link to the release on the issue.
  • Communicate to the kctrl maintainers, so they can update the release notes.
  • Press the Publish Release button
• Update the packaging repositories [kctrl]
  • Check if Update Homebrew
  • Check if Update Website Installation Script
  • Check Github Action
• Update Documentation by generating a new docs version
• Push any artifacts to a registry
• Communicate in Slack
• Add to "Announcements" in Next Community Meeting Agenda

Releasing a patch version and backporting a CVE:

• Validate which branch lines to backport the CVE to. Based on our private confluence page.
• For each line, e.g v0.30.x, v0.38.x, do the following:
  • Validate that the branch contains the latest patches, that no newer code was forgotten to be merged back in.
  • git checkout v0.38.x.
  • git checkout -b v0.38.<next-patch-version>.
  • Make the necessary fixes / cherry-picks.
  • git push origin v0.38.<next-patch-version>.
  • Make a PR.
  • Once approved, merge the changes back to the v0.38.x branch and git push the branch and delete your temporary branch used in the PR.
  • To Release: follow the instructions FROM THE BRANCH YOU ARE UPDATING at docs/dev.md#release in the repository. These will contain the relevant steps at each point of time in the project's history, e.g when updating v0.25.x the url will look like: https://github.com/carvel-dev/kapp-controller/blob/v0.25.x/docs/dev.md#release