releasing-versions.md

Release process

The release process is started by running the following command.

npm run release

This command runs all tests and then builds the lib and dist distributions formats. Next the recent changes are read from CHANGELOG.md and you will be asked to choose what part of the version to bump.

After the version is bumped, the release script automatically updates CHANGELOG.md to note that the recent changes are now part of a release. The updates are committed to git and tagged, then pushed to your upstream branch.

The command will prompt you for your git credentials. If you are using 2FA for git (which you should be) then your git password must be a one time token.

That's it. The latest changes were published to GitHub, a new git tag now exists on GitHub, the new release can be installed from npm, and the documentation site will update momentarily^*.

^{* GitHub Pages sites are cached aggressively and can sometimes take a couple of minutes to update.}