This document outlines how to create a release of net/metrics
-
Set up some environment variables for use later.
# This is the version being released. VERSION=1.21.0
-
Make sure you have the latest master.
git checkout master git pull
-
Alter the release date in CHANGELOG.md for
$VERSION
using the formatYYYY-MM-DD
and remove the trailing-dev
, making the latest version match$VERSION
.-## v1.21.0-dev (unreleased) +## v1.21.0 (2017-10-23)
-
Update the version number in version.go and verify that it matches what is in the changelog.
sed -i '' -e "s/^const Version =.*/const Version = \"$VERSION\"/" version.go make verifyversion
-
Create a commit for the release.
git add version.go CHANGELOG.md git commit -m "Preparing release v$VERSION"
-
Tag and push the release.
git tag -a "v$VERSION" -m "v$VERSION" git push origin master "v$VERSION"
-
Go to https://github.com/yarpc/metrics/tags and edit the release notes of the new tag. Copy the changelog entries for this release int the release notes and set the name of the release to the version number (
v$VERSION
). -
Add a placeholder for the next version to CHANGELOG.md. This is typically one minor version above the version just released.
+v1.22.0-dev (unreleased) +------------------------ + +- No changes yet. + + v1.21.0 (2017-10-23) --------------------
-
Update the version number in version.go to the same version.
-const Version = "1.21.0" +const Version = "1.22.0-dev"
-
Verify the version number matches.
make verifyversion
-
Commit and push your changes.
git add CHANGELOG.md version.go git commit -m 'Back to development' git push origin master