Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.74 KB

releases.md

File metadata and controls

57 lines (43 loc) · 2.74 KB
Raw

Releases

Note: Only members who have at least write access to the gopass repo can create releases.

Gopass uses goreleaser to create releases. The configuration is in the file .goreleaser.yml.

Goreleaser automates most but not all steps of a new release.

Note: We use semantic versioning for the command line interface and tool behaviour but not for the API (i.e. pkg/gopass). Maintaining both properties in the same repository / Go module is too cumbersome.

Development overview

Preparing and creating a new release requires a number of steps. Starting right after the previous release these are roughly:

  • Create a new Milestone in the GitHub issue tracker
  • Create or assign issues for the next Milestone
    • We use Slack to discuss prioritization and responsibilities
  • After enough changes have been accumulated on the master branch we might agree to cut a new release
  • Now we survey open issues for any "blockers" that should make it into the next release
    • This usually either happens in Slack or on semi-regular video calls
  • After all blockers have been addressed we move the remaining issues to the next milestone and prepare the release

Cutting a release

Once master is in good shape we need to update some metadata, build and push the release.

  • Determine the next release version
    • Usually we bump the patch component
    • If we're shipping possibly disruptive changes we bump the minor component
    • So far we've never bumped the major component
  • Grep all RELEASE_NOTES from the commit messages and prepend a new section to the CHANGELOG
    • Major changes should be detailed in a few sentences
  • Write the new version to the VERSION file
  • Write the new version to the version.go file
  • Commit these changes to a branch and open a pull request
  • Once the PR has been merged immediately create a new tag vX.Y.Z and push it to GitHub
    • This will kick-off the goreleaser GitHub Action to build and push the release
    • If GHA is unavailable run goreleaser release --release-notes <(go run helpers/changelog/main.go) (with a valid GITHUB_TOKEN in your env) locally
  • Check the release on GitHub and verify the release notes

Some of these steps have been automated so it boils down to:

  • Determine the next version, a patch increase is assumed. Otherwise provide the new version to the script.
$ go run helpers/release/main.go [X.Y.Z]
$ git push <your-fork> release/vX.Y.Z
# Open a PR, once it's merged
$ git co master
$ git pull origin master
$ git tag -s vX.Y.Z
$ git push origin vX.Y.Z