Update release documentation to reflect new usage of bump-version script.

This commit is contained in:
Vanessa Yuen 2017-09-06 16:41:51 -04:00
parent c56d8b4fe9
commit a81ea1ffde

View file

@ -24,10 +24,17 @@ make sure there are no drafts.
## Bump the version ## Bump the version
Run the `bump-version` script, passing `major`, `minor`, or `patch` as an argument: Run the `bump-version` script with arguments according to your need:
- `--bump=patch` to increment patch version, or
- `--stable` to indicate this is a stable version, or
- `--version={version}` to set version number directly.
**Note**: you can use both `--bump` and `--stable` simultaneously.
There is also a `dry-run` flag you can use to make sure the version number generated is correct before committing.
```sh ```sh
npm run bump-version -- patch npm run bump-version -- --bump=patch --stable
git push origin HEAD git push origin HEAD
``` ```