Release checklist

Jump to bottom

Charles Pierce edited this page Oct 18, 2022 · 24 revisions

Prerequisites

If the release includes any changes to the included files, make sure that https://github.com/volta-cli/action is updated to support those changes (including on older versions!) before publishing the new release.

Release notes

Update ./RELEASES.md with a new entry. Add a bullet item for every user-facing PR that has been merged since the last release.
Update ./Cargo.toml to have the new version in the version field.
Commit this change with a commit message "v$version" where $version is the new version.
Push and make sure CI passes.

Build

Once the release notes are merged into main, update your local copy
Create a new tag, in the form v$VERSION: git tag v0.8.0
Push the new tag to the main repo: git push upstream v0.8.0
The CI process should build and create a draft release named v$VERSION

Publish

Update the draft release, adding the release notes to the description.
Click Publish
Update latest-version in https://github.com/volta-cli/www to $VERSION (without the leading 'v')

Smoke test

curl -sSLf https://get.volta.sh | bash
open new terminal
volta version should report the new $VERSION