Compass Release Runbook
A gated end-to-end runbook for releasing Compass: sync main, bump versions, open the PR, tag the merge commit, build six platforms, and verify every download.
AutomationAdvanced★ 139⑂ 7AI score 7/10Last updated: Aug 19, 2026
What it does
- Enforces safety gates first: clean worktree,
ghauth/permissions, no pre-existing tag or release, writable Cargo target volume. - Bumps only Compass-owned metadata: root workspace
Cargo.toml, internal crate constraints,Cargo.lock, VS Codepackage.json, andCHANGELOG.mdwith a dated section. - Runs the full validation suite pinned to Rust 1.97.1 (
cargo check/fmt/clippy/test, product-boundary and release-script checks, code-graph qualification) plus JS/VSIX checks when relevant. - Opens a draft PR, waits for the six platform checks, then creates an annotated tag on the merge commit and watches the release workflow.
- Downloads the release and verifies all 15 expected assets, checksums, archive listings, and
compass-release.jsonfields before declaring success. - Optionally packages and smoke-tests the VS Code VSIX.
Who it's for
- Maintainers of the crabbuild/compass repository.
- Engineers looking for a reference model of a gated, verifiable multi-platform Rust CLI release.
- Release engineers designing immutable-artifact publishing workflows.
Examples
- "Release Compass 0.3.7" → sync, bump, validate, PR, tag, build, verify downloads.
- "Write the release notes for this version" → curated user-facing notes from commits since the previous
compass-v*tag. - "Also build the 0.3.7 VSIX" → version-match check, package, smoke test, and checksum.
· · · Install guide · · ·
Try it now, no install
Paste this into Claude to use the skill without installing anything.
Read the instructions in this file and follow them to help me: https://raw.githubusercontent.com/crabbuild/compass/HEAD/skills/compass-release/SKILL.md What I want: (describe your task here)
If Claude can't open the link, open it yourself and paste the contents instead.
↓ If it works for you, download the ZIP below and install it. Then it runs on its own — no pasting each time.
Install in the Claude app (no terminal)
- Download the ZIP with the button below.
- In Claude, open Settings → Capabilities and turn on 'Code execution and file creation'. (one time)
- Go to Customize → Skills → + → 'Upload a skill' and upload the ZIP.
Install in Claude Code
Let Claude do it — paste this into Claude Code
Install the skill I found on Claude Skill Mart. Copy the skills/compass-release folder from the GitHub repo crabbuild/compass into my ~/.claude/skills/compass-release/. When it's done, tell me in one line what this skill can do.
Install with a command instead
git clone https://github.com/crabbuild/compass.git && mkdir -p ~/.claude/skills && cp -r compass/skills/compass-release ~/.claude/skills/⚠ This is a third-party skill. Check the source repository before installing.
- Create the skills directory:
mkdir -p ~/.claude/skills - Clone the repo:
git clone https://github.com/crabbuild/compass.git - Copy the skill:
cp -r compass/skills/compass-release ~/.claude/skills/ - Install prerequisites:
git, GitHub CLI (gh),jq, Rust 1.97.1 via rustup, Node/npm,tar, andshasum/sha256sum. - Authenticate with
gh auth loginusing an account that can push branches, tags, and releases. - On macOS, make sure
/Volumes/Workspace/crabbuild-targetexists and is writable; otherwise the skill will stop at its safety gate. - Restart Claude Code and ask something like "release Compass 0.3.7" to trigger the skill.
View source on GitHub ↗License: NOASSERTION