Skip to content

Commit

Permalink
Add Release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Turbo87 committed Nov 15, 2017
1 parent 6e1dbae commit d46e43d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Release Instructions

This project is using [TravisCI](https://travis-ci.org/) to automatically
publish git tags to [npm](https://www.npmjs.com/).

Follow these steps to create a new release:

1) `yarn changelog` – generates the changelog for the new release

2) Add generated changelog to `CHANGELOG.md` and commit with
`Update CHANGELOG` message

3) `yarn version` – updates the `version` property in the `package.json`
file and creates a new git commit and tag for the release

4) `git push upstream master --follow-tags` – pushes the release commit and
tag to the `upstream` remote

5) Wait for TravisCI to finish the build, tests and deployment

Note that for `yarn version` to work properly the `version` field should not
be adjusted manually before the release.

0 comments on commit d46e43d

Please sign in to comment.