-
Notifications
You must be signed in to change notification settings - Fork 7
Publish a release
-
Make sure everything is green on CI
-
Update the version number in the package.json, following semver
-
Run
npm install
, which updates the package-lock.json with the updated version number. -
Update the CHANGELOG.md file. Add a heading for the new version and the release date below the "unreleased" heading. Move any items in the "unreleased" section into the section for the new version, along with any other items that will be in the release.
For example, if the CHANGELOG looks like
## Unreleased - My awesome new feature ## v6.6.6 (1984-12-21) - A really old feature
You would update it as follows for v6.7.0
## Unreleased ## v6.7.0 (2020-12-04) - My awesome new feature ## v6.6.6 (1984-12-21) - A really old feature
-
Create a commit (with the updated version number and changelog entry) directly on the main branch, with the version number as the commit message. This should be preceded by
v
. For example, for version 6.6.6, the commit message should bev6.6.6
-
Push this commit
-
Go to the releases page and draft a new release
-
Enter the version (i.e. v6.6.6) into the "tag version" and "release title" fields
-
Copy the version's content from the CHANGELOG into "describe this release".
-
Click "publish release". This will create a tag for the version
-
From your terminal, run
git pull
to pull down the tag -
Run
npm publish --dry-run
to see what files will be published -
If everything looks good, run
npm publish
(you may have to do some npm setup for this to work)