Skip to content

RELEASING.md

Latest commit

 

History

History
22 lines (14 loc) · 1.36 KB

RELEASING.md

File metadata and controls

22 lines (14 loc) · 1.36 KB
Raw

Releasing

The maintainer/owner runbook for cutting a duodiff release. Contributors don't need any of this — see CONTRIBUTING.md.

How a release works

A release is a vX.Y.Z git tag that matches Cargo.toml's version. Pushing the tag triggers the full pipeline:

  • .github/workflows/release.yml — builds and attaches the platform binaries to the GitHub Release.
  • .github/workflows/publish.yml — publishes the crate to crates.io.

The crate is published once the CARGO_REGISTRY_TOKEN secret is configured, so the publish step runs automatically on tag.

Packaging stays lean via Cargo.toml exclude (the CI config, install scripts, and docs are kept out of the published tarball); cargo publish --dry-run validates the tarball.

Cutting a release

  1. Bump version in Cargo.toml (and refresh Cargo.lock by running a build); confirm cargo publish --dry-run is clean.
  2. In CHANGELOG.md, retitle the ## [Unreleased] entries under a dated ## [X.Y.Z] — YYYY-MM-DD heading, and add back an empty ## [Unreleased] heading above it as a placeholder for the next cycle.
  3. Merge to main (CI gate green).
  4. Tag and push: git tag vX.Y.Z && git push origin vX.Y.Z.
  5. Verify: the GitHub release has the binaries, crates.io shows the new version (and docs.rs built).