Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Releasing criv

Use Cocogitto to calculate the next SemVer version from conventional commits, then use cargo-release to update workspace Cargo versions.

Before preparing a release, run:

cargo test --workspace
cargo fmt --check
target/debug/criv check
target/debug/criv enforce --stage ci
target/debug/criv watch --once
target/debug/criv query diff latest latest

target/debug/criv check embeds rumdl as a Rust crate, so Markdown formatting does not require a separate rumdl executable.

Build plugin artifacts when the Obsidian plugin is part of the release:

npm --prefix .obsidian/plugins/criv run build

This wraps the plugin’s npm run build script in mise x rust@1.97.1 so wasm-pack sees the mise-managed Rust and Cargo toolchain, including the installed wasm32-unknown-unknown target. If only the Rust CLI is being released and the generated plugin scaffold is unchanged, document that choice in the release notes.

Preview the next automatically selected version:

mise run release-plan

For a tag-only release:

mise run release-auto

release-auto is implemented by scripts/release-auto.sh. It requires a clean main branch, asks Cocogitto for the next version with cog bump --dry-run --auto, updates workspace Cargo versions, runs the pre-release checks above, commits the version bump, creates vX.Y.Z and criv-wasm-vX.Y.Z, and pushes the commit and tags.

Conventional commits drive the automatic bump: fix produces a patch release, feat produces a minor release, and ! or BREAKING CHANGE: produces a major release. While criv is still in 0.y.z, Cocogitto will not automatically select 1.0.0; cut that intentionally with a manual versioned release if needed. This decision is captured in ADR-0016.

The next release remains git-tag-only. Do not publish criv to crates.io until the CLI API, state schema compatibility policy, and installer story are stable enough to support registry consumers. The tag-triggered GitHub binary release is the authoritative distribution path for now.

When crates.io publishing is intentionally enabled later, confirm the package metadata first:

cargo package --workspace --allow-dirty
cargo publish --dry-run

Then run the matching cargo release command without --no-publish. Crates.io publishing remains manual for now; release-auto only cuts the tag-triggered binary release.

Current tag names use:

  • vX.Y.Z for the root CLI crate.
  • criv-wasm-vX.Y.Z for the WASM helper crate.

Release binary automation should run only when a v* root CLI release tag is pushed. The workflow should build criv archives named by Rust target triple:

  • criv-x86_64-unknown-linux-gnu.tar.gz
  • criv-aarch64-unknown-linux-gnu.tar.gz
  • criv-aarch64-apple-darwin.tar.gz
  • criv-x86_64-pc-windows-msvc.zip

Intel macOS release archives are deprecated by ADR-0017 because the hosted Intel macOS runner is the slowest release job. Apple Silicon macOS remains the supported macOS binary target. Reintroduce criv-x86_64-apple-darwin.tar.gz only if there is measured user demand or a faster runner path.

Release assets should include SHA256SUMS.txt, GitHub build provenance attestations, and criv --version as the installer smoke test for future aqua and mise registry entries. This decision is captured in ADR-0014.

Each platform archive also includes vscode-criv.vsix next to the executable. The release workflow builds that package once and adds the same local-only viewer to every archive, as required by ADR-0087.

Release binaries use the workspace release profile in Cargo.toml: symbols are stripped, size optimization is enabled, LTO runs at link time, codegen uses one unit, and release panics abort. This keeps downloadable artifacts smaller without requiring nightly Rust or post-build binary packing. The profile decision is captured in ADR-0015.

The CLI embeds local Git repository access through its Rust dependency graph; the release artifact does not require a git executable for query-diff or enforcement repository reads. Release verification should keep a PATH-without- Git smoke test alongside the hosted core validation profile. The backend scope and dependency evidence are recorded by the embedded-repository-access ADR.