Skip to content

Latest commit

 

History

History
127 lines (93 loc) · 3.11 KB

release.md

File metadata and controls

127 lines (93 loc) · 3.11 KB
Raw

Release Process

Back to README.md

This document outlines how to create a release of prototool.

  1. Set up some environment variables for use later.

    # This is the version being released.
VERSION=1.21.0

# This is the branch from which $VERSION will be released.
# This is almost always dev.
BRANCH=dev

    ** If you are copying/pasting commands, make sure you actually set the right value for VERSION above. **

  2. Make sure you have the latest master.

    git checkout master
git pull

  3. Merge the branch being released into master.

    git merge $BRANCH

  4. Alter the Unreleased entry in CHANGELOG.md to point to $VERSION and update the link at the bottom of the file. Use the format YYYY-MM-DD for the year.

    -## [Unreleased]
+## [1.21.0] - 2017-10-23
    -[Unreleased]: https://github.com/uber/prototool/compare/v1.20.1...HEAD
+[1.21.0]: https://github.com/uber/prototool/compare/v1.20.1...v1.21.0

  5. Update the version number in internal/vars/vars.go and the docs/install.md and verify that it matches what is in the changelog.

    -const Version = "1.21.0-dev"
+const Version = "1.21.0"

  6. Create a commit for the release.

    git add internal/vars/vars.go docs/install.md CHANGELOG.md
git commit -m "Preparing release v$VERSION"

  7. Tag and push the release.

    git tag -a "v$VERSION" -m "v$VERSION"
git push origin master "v$VERSION"

  8. Build the release artifacts. This will put files in the release package that will be uploaded in the next step.

    make releasegen
ls release

  9. Go to https://github.com/uber/prototool/tags and edit the release notes of the new tag. Copy the changelog entries for this release in the release notes and set the name of the release to the version number (v$VERSION). Upload the release artifacts from the release directory.

  10. Switch back to development.

    git checkout $BRANCH
git merge master

  11. Add a placeholder for the next version to CHANGELOG.md and a new link at the bottom.

    +## [Unreleased]
+- No changes yet.
+
 ## [1.21.0] - 2017-10-23
    +[Unreleased]: https://github.com/uber/prototool/compare/v1.21.0...HEAD
 [1.21.0]: https://github.com/uber/prototool/compare/v1.20.1...v1.21.0

  12. Update the version number in internal/vars/vars.go to a new minor version suffixed with "-dev".

    -const Version = "1.21.0"
+const Version = "1.22.0-dev"

  13. Commit and push your changes.

    git add CHANGELOG.md internal/vars/vars.go
git commit -m 'Back to development'
git push origin $BRANCH

  14. Update the Homebrew formula using brew bump-formula-pr. This will create a fork of github.com/Homebrew/homebrew-core and create a PR with the updated formula for Prototool.

    brew bump-formula-pr --url=https://github.com/uber/prototool/archive/v$VERSION.tar.gz prototool