Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.23 KB

RELEASE_CHECKLIST.md

File metadata and controls

24 lines (17 loc) · 1.23 KB
Raw

Release checklist

This checklist is meant to be used as a guide for the crates.io release process.

Releases are always made in lockstep, meaning that all crates in the repository are released with the same version number, regardless of whether they have changed or not.

Requirements

Steps

  • Create a new branch: git checkout -b release-<version>
  • Run cargo-release to handle the version bump, changelog, and commit: cargo release --execute --no-publish --no-tag --allow-branch=<branch> <version>
  • Update changelog message if necessary.
  • Push, open and merge the PR. The name of the PR should be the same as the cargo-release commit message.
  • git checkout main and git pull.
  • Verify dist plan is correct.
  • Run cargo-release to tag and publish: cargo release --execute [--no-verify] <version>

These steps are adapted from the recommended cargo-release + dist workflow, described in more detail here.