Skip to content

RELEASING.md

Latest commit

 

History

History
39 lines (31 loc) · 1.39 KB

RELEASING.md

File metadata and controls

39 lines (31 loc) · 1.39 KB

Release process

Steps

  1. Determine the new release's version number

    • Follow Semantic Versioning 2.0 semantics
      • Be mindful of the v0.x.y semantics!
    • The placeholder vX.Y.Z is used to refer to the tag name including this version number in all steps below

  2. Check out the repository on the correct commit, which is most likely origin/main

    git fetch
git checkout origin/main -b ${USER}/release/vX.Y.Z

  3. Edit internal/version/version.go to set the Tag constant to the new vX.Y.Z version

  4. Commit the resulting changes

    git commit -m "release: vX.Y.Z" internal/version/version.go

  5. Open a pull request

    gh pr create --web

  6. Get the PR reviewed by a colleague, ensure all CI passes including the Release validations

  7. Get the PR merged to main via the merge queue

  8. Once merged, a draft release will automatically be created on GitHub (see .github/release.yml for more details)

    • Locate it on the releases page
    • Review the release notes, and edit them if necessary:
      • Remove chore: entries
      • Fix any typos you notice

  9. Once validated, publish the release on GitHub

    • This automatically creates the release tag, so you're done!