diff --git a/RELEASE.md b/RELEASE.md index 56de7ed8..050e34ef 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,6 +9,11 @@ npm version --preid pre --no-git-tag-version `--preid` specifies which suffix to use in the release such as `pre`, `next`, `beta`, `rc`, etc. `prepatch`, `preminor`, and `premajor` start a new series of pre-releases while bumping the patch, minor, or major version. E.g. `premajor` with `--preid pre` would do a prerelease for a new major using the `-pre` suffix (i.e. it would be a new major with `-pre.0`) + +You can use `prerelease` to bump the version for a new pre-release version. E.g. you could run `npm version prerelease --preid pre --no-git-tag-version` to go from `-pre.0` to `-pre.1`. + +For regular versions, you can use `patch`, `minor`, or `major`. E.g. `npm version major --no-git-tag-version`. + 2. Update the changelog, which can be found in `CHANGELOG.md`. The heading must match `## ` exactly, or it will not be picked up. For example, for version 1.0.11: ```