Skip to content
This repository was archived by the owner on Jul 20, 2026. It is now read-only.

RELEASE.md

Latest commit

 

History

History
15 lines (14 loc) · 1.3 KB

RELEASE.md

File metadata and controls

15 lines (14 loc) · 1.3 KB
Raw

Release Instructions

  1. Determine the SemVer version for the new release: $VERSION. Note: semver does not include a v prefix.
  2. Generate a changelog using ghch ghch --format=markdown --next-version=v$VERSION.
  3. Create a new branch pointing to the trunk git fetch origin && git switch -c release/$VERSION origin/master.
  4. Update CHANGELOG.md with the generated changelog.
  5. Update version/version.go with the new version.
  6. Push your branch and wait for CI to pass.
  7. Merge your branch.
  8. Switch back to the trunk branch: git switch master.
  9. Pull the trunk branch with tags, and ensure it is pointing to the commit you want to release.
  10. Tag the release with the new version: git tag -sm v$VERSION v$VERSION.
  11. Push the tag to GitHub: git push --tags.
  12. A tag build will commence on the pipeline. Wait for and unblock the release steps.
  13. Check that the draft release that the build creates is acceptable and release it. Note: the job log for release step on the tag build will contain a link to the draft release.