Skip to content

Commit

Permalink
update release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
busticated committed Nov 11, 2021
1 parent 0f1b22c commit bff57b7
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Releasing a new version

- Checkout the `master` branch.

- `npm version <major | minor | patch>`

- This will bump the version in `package.json`, update the reference docs, and make a version commit and a tag for you.

- `git push && git push --tags`

- Travis will publish to npm when the build succeeds.
Packages are only released from the `master` branch after peer review.

1. make sure you have the latest:
* `$ git checkout master`
* `$ git pull`
2. make sure tests pass
* `$ npm test`
3. bump the version
* `$ npm version <major|minor|patch>`
4. push your tags:
* `$ git push origin main --follow-tags`

_CI will publish to npm when the build succeeds_

0 comments on commit bff57b7

Please sign in to comment.