Release

This page documents the process of releasing the @viz-js/viz package. The commands are meant to be run on a local checkout of the repository.

I plan to change this at some point to use a workflow triggered by creating a release tag.

Checkout default branch

git switch v3
git pull

Bump package version

npm version minor --workspace packages/viz

Note the version for later steps.

Verify that locked dependencies didn't change

Only the packages/viz version should change. Dependencies should be updated separately.

git diff package-lock.json

Review the changelog for this version and edit if necessary

Update the changelog heading for this release

Use the version number of this release instead of "Unreleased"

Create release branch

Where X-Y-Z is the version spelled with hyphens instead of periods:

git switch -c viz-prepare-release-X-Y-Z

Create release commit

Where X.Y.Z is the version:

git add package-lock.json packages/viz/package.json packages/viz/CHANGELOG.md
git commit -m "Release @viz-js/viz X.Y.Z"

Push release branch

git push --set-upstream origin HEAD

Create a PR for the release branch and merge it to the default branch

Run the "Publish viz" workflow on the default branch

Verify that the workflow will use the release commit.

If the API documentation changed, publish the website