From a81ea1ffdeeeec35e4e9bd1f05a9e38a440b7c4c Mon Sep 17 00:00:00 2001 From: Vanessa Yuen Date: Wed, 6 Sep 2017 16:41:51 -0400 Subject: [PATCH] Update release documentation to reflect new usage of `bump-version` script. --- docs/development/releasing.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/development/releasing.md b/docs/development/releasing.md index a40ac2ce140..1ef83234f8c 100644 --- a/docs/development/releasing.md +++ b/docs/development/releasing.md @@ -24,10 +24,17 @@ make sure there are no drafts. ## 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 -npm run bump-version -- patch +npm run bump-version -- --bump=patch --stable git push origin HEAD ```