Skip to content

Latest commit

 

History

History
15 lines (14 loc) · 1.25 KB

RELEASING.md

File metadata and controls

15 lines (14 loc) · 1.25 KB

Releasing

  • If there are changes going out that should be updated in the docs, prep a docs PR.
  • Update version number in main.go
  • Update CHANGELOG.md with the changes since the last release. Consider automating with a command such as these two:
    • git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log
    • git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'
  • Commit changes, push, and open a release preparation pull request for review.
  • Once the pull request is merged, fetch the updated main branch.
  • Apply a tag for the new version on the merged commit (e.g. git tag -a v0.1.0-alpha -m "v0.1.0-alpha")
  • Push the tag upstream (this will kick off the release pipeline in CI) e.g. git push origin v0.1.0-alpha
  • Ensure that there is a draft GitHub release created as part of CI publish steps.
  • Click "generate release notes" in GitHub for full changelog notes and any new contributors
  • Publish the GitHub draft release - if it is a prerelease (e.g. beta) click the prerelease checkbox.
  • Update network agent helm chart with the changes