Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.28 KB

README.dev.md

File metadata and controls

26 lines (22 loc) · 1.28 KB
Raw

Prereqs

  • You must have the GitHub CLI tool (gh) installed, in your path, and logged into an account that can make GitHub releases on the repo.
  • Your environment also must have bash, git and sed available.

Releasing

  • Review open issues and PRs to see if anything needs to be addressed before release.
  • Create a branch e.g. horgh/release and switch to it.
    • main is protected.
  • Set the release version and release date in CHANGELOG.md. Be sure the version follows Semantic Versionsing.
    • Mention recent changes if needed.
  • Commit these changes.
  • Run dev-bin/release.sh.
  • Verify the release on the GitHub Releases page.
  • If everything goes well, the authorized releasers will receive an email to review the pending deployment. If you are an authorized releaser, you will need to approve the release deployment run. If you are not, you will have to wait for an authorized releaser to do so.
  • Make a PR and get it merged.

NOTE: if a major version release is happening, it's necessary to update the go.mod file, as well as the import of internal packages according to the new major version (see more on releasing modules v2 or higher)