Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.42 KB

RELEASE.md

File metadata and controls

23 lines (14 loc) · 1.42 KB
Raw

Instructions for making a release

  1. Change the version number in package.json. Run the following command in the package root directory, replacing <update_type> with one of the semantic versioning release types (prerelease, prepatch, preminor, premajor, patch, minor, major):
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.

  1. 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:
## 1.0.11
  1. Commit and push the changes. On push the release workflow will automaticlly check if the release has been published on npm. If the release has not yet been published, the workflow will update the abi crosswalk file and publish a new npm release.