Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.15 KB

MAINTAINERS_GUIDE.md

File metadata and controls

28 lines (20 loc) · 1.15 KB

Maintainer's Guide Notes

Release Process

We use GoReleaser to do the heavy lifing when releasing new versions of om.

It will create a new GitHub release, attach the binaries, and update the Homebrew formula.

Here's a quick rundown of the process:

  1. Make sure you have the latest version of GoReleaser installed. See install instructions.

  2. Ensure you have explorted your GitHub token as an environment variable.

    export GITHUB_TOKEN=<your_token>
    
  3. Create a new tag for the release.

    git tag -a <Major.Minor.Patch> -m "Release v<version>"
    git push origin <Major.Minor.Patch>
    
  4. Run GoReleaser to create the release.

    goreleaser release
    
  5. Edit the newly created release on GitHub. There's feature to automatically create release notes between two tags. Use it and then clean up redundant or uninformative entries. See these instructions for more information.