Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.54 KB

RELEASING.md

File metadata and controls

29 lines (22 loc) · 1.54 KB

Releasing

mft is published to crates.io, with mft_dump binaries attached to a GitHub release.

One-time setup

  • A crates.io token in the CRATES_IO_TOKEN Actions secret.

Cut a release

  1. Pick the version. While on 0.x, a breaking change or a new feature bumps the minor version and fixes alone bump the patch version. cargo semver-checks check-release flags API breaks.
  2. Open a chore(release): X.Y.Z PR that bumps version in Cargo.toml (Cargo.lock is not tracked) and renames ## [Unreleased] in CHANGELOG.md to ## [X.Y.Z] - YYYY-MM-DD. That section becomes the GitHub release's notes, followed by GitHub's list of merged PRs, and CI fails the PR without it.
  3. Merge it.

The merge runs .github/workflows/auto-tag.yml. It sees a Cargo.toml version with no tag, pushes the vX.Y.Z tag on the merge commit, and runs .github/workflows/release.yml on the tag: preflight, binaries, GitHub release, then cargo publish last. If the version has no notes in CHANGELOG.md, auto-tag fails without tagging it; merging a PR that adds them runs it again.

Pushing a vX.Y.Z tag by hand still runs release.yml directly; auto-tag then skips that version because the tag exists. If auto-tag pushed the tag but no release started, run release.yml on the tag from the Actions tab. To retry a failed release, re-run the failed jobs of its release.yml run. If it failed because of the code, leave the tag where it is and ship the fix as the next patch release; the crates.io publish runs last, so that version never reached crates.io.