Skip to content

Commit

Permalink
Update RELEASE.md
Browse files Browse the repository at this point in the history
Co-authored-by: Ben McCann <[email protected]>
  • Loading branch information
acalcutt and benmccann committed Dec 7, 2024
1 parent e6cc652 commit 0d24ac6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ npm version <update_type> --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 `## <VERSION>` exactly, or it will not be picked up. For example, for version 1.0.11:

```
Expand Down

0 comments on commit 0d24ac6

Please sign in to comment.