Repository navigation
Description
Release CRATE MAJOR.MINOR+1.0
Release-managed crates are payjoin, payjoin-cli and payjoin-mailroom. Versions follow
Semantic Versioning. Tags are <crate>-<version>. The changelog for this release is the
set of fragments in CRATE/changelog.d/; each pull request that landed since the last
release wrote its own, so there is nothing to compile here.
Summary
Checklist
Bump
- Branch
bump-CRATE-MAJOR-MINOR+1frommaster. - Run
contrib/release/bump.sh CRATE MAJOR.MINOR+1.0. It sets the version, rewrites
every workspace member's requirement on the crate, moves the fragments in
CRATE/changelog.d/into a new## MAJOR.MINOR+1.0section ofCRATE/CHANGELOG.md
and deletes them, fills in the
0.0.0-unreleasedplaceholders in the crate's source, regenerates both lock files
and runs check-invariants. It needs jq, and the lock file step calls
cargo +nightly, so run it where rustup has a nightly toolchain.nix develop .#release
has jq but no rustup; there, pass--no-lock, then runcontrib/update-lock-files.sh
from a rustup shell andcontrib/release/check-invariants.sh CRATEagain. - Read the new changelog section once; fix wording, do not add history.
- One commit, "Bump CRATE version to MAJOR.MINOR+1.0". Open the PR against
master.
TheCheck release version bumpjob runs check-invariants, a publish dry run and,
forpayjoin, cargo-semver-checks. - Merge.
If a pull request for CRATE merges while the bump PR is open, rebase the bump branch on
master, run contrib/release/bump.sh CRATE MAJOR.MINOR+1.0 again and amend the bump
commit. At a version it already set, bump.sh moves the new fragments into that version's
section and fills in any new placeholders. If one merges after the bump PR and before the
tag, do the same in a new pull request; if that fills in placeholders under CRATE/src,
it needs the changelog: none label. tag.sh refuses to tag while CRATE/changelog.d/
holds a fragment.
Tag and publish
- Check out the merged
mastercommit. Run
nix develop .#release -c contrib/release/tag.sh CRATE. It checks the tree is clean
and on payjoin/rust-payjoin'smaster(fetched by URL, so any remote layout works),
runs check-invariants, and creates the signed tagCRATE-MAJOR.MINOR+1.0with a key
fromcontrib/release/keys/. - Push the tag with the command the script prints.
- Approve the
releaseenvironment when the workflow asks. Publication, the GitHub
release and the crates.io/docs.rs verification run from there.
After a payjoin release
- Prepare the bindings bump with
contrib/release/bump.sh payjoin-ffi X.Y.Z,
which also sets the language package manifests, their lock files and
changelogs, and follow the
bindings release instructions. Dart's
published native source is pinned automatically to the release checkout.
Once merged, create one signed tag with
nix develop .#release -c contrib/release/tag.sh payjoin-ffi, then push it. - Bump dependent release crates (
payjoin-cli,payjoin-mailroom) on their own
schedule, each with this checklist. Their tags verify thatpayjoinis already on
crates.io.
Announce
- Discord, Twitter, Nostr, stacker.news, using the Summary.
Activity