The standing procedure for a release X.Y.Z (tag vX.Y.Z). Each step is verified before the next one runs; the
commands assume gh is logged in to an account that can push tags to BitmapAsset/probbit.
Every release updates the landing page in its release PR: README.md's line "The current release is vX.Y.Z.", every
release tag the README shows (the GitHub Action example and its version input), and the "What's new in X.Y.Z" block
(what changed, whether it is opt-in, the measured numbers with their BENCHMARKS.md section, links to the release notes and
the RFC). probbit-cli/tests/readme_release.rs fails when the README's current release disagrees with Cargo.toml
(equal on a release, lower on a -dev build) or when the README shows a tag newer than it.
-
Release PR (branch
release-X.Y.Z, squash subjectRelease probbit X.Y.Z (#N)), from a greenmain:Cargo.toml'sversionand theversionof the internal path dependencies (probbit-cli,probbit-decide,probbit-ir,probbit-core,probbit-persona: theprobbit-nostdentries too);cargo update --workspace --offlineforCargo.lock(CI builds--locked);cargo build --release --locked -p probbit-cli, thentarget/release/probbit man > docs/probbit.1(generated, never hand-edited:probbit-cli/tests/cli_man.rscompares them);npm/package.json'sversion; the example tag ininstall.sh,install.ps1,action.yml,.github/workflows/bench.yml,scripts/bench/test_install_ps1.ps1andscripts/tests/test_install_contract.py; the title ofdocs/CHEATSHEET.md; the strand header example indocs/persona.md§5.7;CHANGELOG.md:## X.Y.Z - <date>, with an upgrade note wherever an exit code or an output changes;- the landing page (above).
Before merging:
git grep -n "X.Y.Z-dev"finds only recorded test fixtures;python3 bench/individuality/p0.py checkwith the release build gives 0 differences (its corpus is never regenerated);cargo publish --dry-run --workspace --lockedandnpm pack --dry-run(innpm/) package version X.Y.Z; the four required checks pass. -
Tag the release squash commit on
main:git tag -a vX.Y.Z <sha> -m "probbit X.Y.Z", thengit push origin vX.Y.Z(the tag only).release.ymlbuilds a draft release with 15 assets: 6 archives, the macOS app (probbit-Monitor-vX.Y.Z-macos.zip, docs/monitor-app.md), 7.sha256files andprobbit.1. Signing of the app asset: with the sixAPPLE_*repository secrets set (docs/monitor-app.md, "Signing and notarization"),release.ymlsigns the app with the Developer ID and the hardened runtime, notarizes it and staples the ticket, and its notes say "notarized"; without them the asset is signed ad-hoc and the notes say so. A notarization that is not accepted fails the job and leaves no app asset. -
Check the draft: download the macOS arm64 archive, check it against its
.sha256, run./probbit version: it printsprobbit X.Y.Z. -
Publish:
gh release edit vX.Y.Z --draft=false --title "probbit X.Y.Z" --notes-file <notes>. Then the installers on a clean directory: theinstall.shone-liner (latest) andPROBBIT_VERSION=vX.Y.Zboth installprobbit X.Y.Z. -
npm, after the release is published (
npm/install.jsdownloads its assets):npm pack --dry-run, thennpm publish --access public;npm view probbit versionanddist-tags.latestgive X.Y.Z, and a clean-prefixnpm i -g probbit@X.Y.Zprintsprobbit X.Y.Z. The token stays out of every file: a throwaway--userconfigwhose one line is//registry.npmjs.org/:_authToken=${NPM_TOKEN}(npm expands the variable), withNPM_TOKENset only in that shell,npm --userconfig <file> whoamifirst, the file deleted after. The OpenClaw plugin (plugins/openclaw, npmprobbit-stance), when its version changed: afterprobbitis on npm,npm ci && PROBBIT_BIN=$(command -v probbit) npm testwith the released binary,npm pack --dry-run(15 files at 0.2.0:dist/src/*.js,openclaw.plugin.json,personas/assistant.yaml,install/openclaw-entries.json,README.md,package.json; no tests), thennpm publish --access publicwith the same userconfig;npm view probbit-stance versiongives the new version. ItsMIN_PROBBIT(src/version.ts) names the oldest probbit it runs. -
crates.io:
cargo publish --workspace --lockedfrom the tag, which publishes in dependency order (probbit-nostd,probbit-core,probbit-ir,probbit-decide,probbit-persona,probbit-cli;probbit-wasmhaspublish = false).probbit-nostdgoes first: the engine crates name it as an optional dependency with a version. -
Back to development:
mainmoves to the next-devversion (Cargo.toml, the path dependencies,Cargo.lock,docs/probbit.1); the README goes on naming the released version until the next release PR.
- Before the tag: a revert PR of the release commit.
- While the release is a draft:
gh release delete vX.Y.Z --yes, then delete the tag (git push origin :refs/tags/vX.Y.Z). - After publishing: fix forward with the next patch release;
gh release edit vX.Y.Z --prereleasetakes it off "latest", which the installers use by default. - npm: never unpublish.
npm deprecate probbit@X.Y.Z "<reason>"andnpm dist-tag add probbit@<previous> latest. - crates.io versions are permanent:
cargo yank --version X.Y.Z <crate>for each crate, then the next patch release.