This document describes the steps to release a new version of DNSimple/Node.
- You have commit access to the repository
- You have push access to the repository
- You have a GPG key configured for signing tags
-
Determine the new version using Semantic Versioning
VERSION=X.Y.Z
- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes
-
Run tests and confirm they pass
npm test -
Set the version in
package.json{ "version": "$VERSION", } -
Run tests again and confirm they pass
npm test -
Update the changelog with the new version
Finalize the
## mainsection inCHANGELOG.mdassigning the version. -
Commit and push the changes
git commit -a -m "Release $VERSION" git push origin main -
Wait for CI to complete
-
Create a signed tag
git tag -a v$VERSION -s -m "Release $VERSION" git push origin --tags
GitHub Actions will take it from here and publish to npm.
- Verify the new version appears on npm
- Verify the GitHub release was created