1.8 KiB
1.8 KiB
Release
A guide for creating a release.
Background
This project release guide is based on
Steps
$ git checkout develop
$ git checkout -b release-<newversion>
- Do all of the release branch testing necessary. This could be as simple as running
npm test:ci
, or it could take user testing over a few days. $ npm version <newversion>
(see npm-version for valid values of ).$ git checkout release
$ git merge --no-ff release-<newversion>
$ git push && git push --tags
$ git checkout develop
- Create a release on GitHub. Make sure that you release from the
release
branch! You can do this in one of two ways:- (Preferred) Use the
hub
command line tool. You can automate adding all commit messages since the last release with the following command:
Note that this creates a draft release, which you can then edit on GitHub. This allows you to create release notes from the list of commit messages, but then edit these notes as you wish.$ hub release create -d -m "<newversion>" -m "$(git log `git describe --tags --abbrev=0 HEAD^`..HEAD --oneline)" <newversion>`
- Draft a new release on Github.
- (Preferred) Use the
$ git merge --no-ff release-<newversion>
Travis CI will automatically deploy the release to production, as well as push a production tagged Docker image to DockerHub.