name: app-release description: Use when the user asks to release a new version, ship a build, or publish a Skill Zoo release. Also use when a tag push results in Homebrew 404 errors or missing artifact failures.
Release
Overview
Release is done by pushing a v* tag. CI builds all platforms, creates a GitHub Release, and updates the Homebrew cask. Manual steps: update CHANGELOG.md, then tag and push.
Announce at start: "I'm using the release skill to ship a new version."
When to Use
digraph when_release {
"User asks to release/ship/publish?" [shape=diamond];
"Use this skill" [shape=box];
"Homebrew 404 or artifact-not-found after a tag push?" [shape=diamond];
"Use this skill" [shape=box];
"Pre-release checks (code review, QA)?" [shape=diamond];
"Not this skill — use requesting-code-review" [shape=box];
"User asks to release/ship/publish?" -> "Use this skill" [label="yes"];
"User asks to release/ship/publish?" -> "Homebrew 404 or artifact-not-found after a tag push?" [label="no"];
"Homebrew 404 or artifact-not-found after a tag push?" -> "Use this skill" [label="yes"];
"Homebrew 404 or artifact-not-found after a tag push?" -> "Pre-release checks (code review, QA)?" [label="no"];
"Pre-release checks (code review, QA)?" -> "Not this skill — use requesting-code-review" [label="yes"];
}
Use when:
- User says "release", "ship", "publish", "new version", "bump version"
- Homebrew cask update failed (404 on DMG URLs)
- CI
create-releasejob failed to find artifacts
Don't use for:
- Code review before releasing
- Deciding WHAT version number (ask the user)
- Feature work or bug fixes
Quick Reference
| Step | Command |
|---|---|
| Check existing tags | git tag --sort=-v:refname | head -5 |
| Prerequisites (in order) | fmt → lint:rs → test → typecheck → lint → format:check → status |
| Check Rust formatting | cargo fmt --check --manifest-path src-tauri/Cargo.toml |
| Check Rust lint | bun run lint:rs |
| Check TypeScript types | bun run typecheck |
| Check frontend lint | bun run lint |
| Check frontend formatting | bun run format:check |
| Check uncommitted changes | git status --short |
| Tag and push | git push origin main && git tag v<VERSION> && git push origin v<VERSION> |
Core Pattern
All file changes (CHANGELOG, Cargo.toml, Cargo.lock, package.json) are made and committed together in a single commit. Do not commit after each step. (docs/version.json is updated by CI post-release.)
1. Confirm Version
Ask the user. Check git tag --sort=-v:refname | head -5 for context. Version must start with v (only v* tags trigger CI).
2. Update CHANGELOG.md
Add a new version section before the previous release entry:
## [X.Y.Z] — YYYY-MM-DD
Use today's date. Group changes under Added, Changed, Fixed headings. Review commits since the last tag with git log --oneline v<LAST>..HEAD to ensure nothing is missed.
Do NOT commit yet — all changes go into one commit in Step 5.
3. Protocol Impact Check
After writing the changelog, decide whether this release changes the desktop-owned local protocol. Desktop is the source of truth for local state; the CLI is an adjunct control surface and must follow the desktop protocol.
Use changed paths as review prompts, not automatic gates. Relevant prompts include desktop persistence structs, archive/restore behavior, local state paths or shapes, schema versions, and CLI protocol read/write code. Trigger the protocol gate only when the release changes desktop-owned local state shape, paths, schema versions, lock/archive write semantics, or user-visible compatibility/migration behavior.
If there is no protocol impact, note it internally and continue. Do not add "no impact" lines to CHANGELOG or commit messages.
If there is protocol impact, verify before continuing:
AGENTS.mdguidance still reflects the desktop-owned protocol relationship.docs/local-protocol.mdreflects the current desktop protocol.fixtures/local-protocol/represents the desktop protocol, not CLI implementation convenience.- CLI and Rust protocol fixture tests pass.
- CHANGELOG mentions any user-visible compatibility, migration, or breaking behavior.
4. Update Version Files
Update src-tauri/Cargo.toml to match the release version:
sed -i '' 's/^version = ".*"/version = "X.Y.Z"/' src-tauri/Cargo.toml
cargo check --manifest-path src-tauri/Cargo.toml # regenerates Cargo.lock
Update package.json to match (no v prefix — npm uses bare semver):
sed -i '' 's/"version": ".*"/"version": "X.Y.Z"/' package.json
Do NOT update docs/version.json here — CI updates it automatically after the release is published.
Do NOT commit yet — all changes go into one commit in Step 5.
5. Verify Prerequisites
Run all checks in order. If any fails, fix and re-run the full sequence until clean — formatting changes can cascade into lint results. Any fixes become part of the same release commit.
cargo fmt --check --manifest-path src-tauri/Cargo.toml— runcargo fmt --manifest-path src-tauri/Cargo.tomlif diffs appear, then restart from herebun run lint:rs— fix all warnings; fmt may have introduced new onescargo test --manifest-path src-tauri/Cargo.toml --features test-helpers— fix any test failures before proceedingbun run typecheck— fix all type errors before proceedingbun run lint— fix any lint errors. Note: pre-existing issues unrelated to this release should be noted separately, not silently fixed in the release commitbun run format:check— runbun run formatif diffs appear. CI also enforces this, but catching it locally avoids a broken tagRELEASE_BODY.mduses__VERSION__and__COMMITS__placeholders — never hardcoded version numbersgit status --short— only expected files (CHANGELOG.md, Cargo.toml, Cargo.lock, package.json, plus any fmt/clippy fixes) should appear.docs/version.jsonshould NOT appear (CI updates it post-release). Anything else is a stray change that could slip into the release commit.
When all checks pass, commit everything in a single commit:
git add CHANGELOG.md src-tauri/Cargo.toml src-tauri/Cargo.lock package.json
# also add any files modified by fmt/clippy fixes above
git commit -m "chore: release vX.Y.Z"
6. Tag and Push
CRITICAL: Pushing a
v*tag triggers CI to build and publish a release. Always tell the user explicitly that a push is about to happen and get their consent before executing. Never push without approval.
git push origin main
git tag v0.1.2
git push origin v0.1.2
7. CI Jobs (triggered by v* tag)
| Job | Outcome |
|---|---|
| build | Universal DMG, NSIS installer, portable zip → renamed to Skill-Zoo-v{VERSION}-{platform}.{ext} |
| create-release | GitHub Release with substituted release notes + all artifacts |
| update-homebrew | Computes SHA256, updates cask formula, opens PR, and auto-merges |
docs/version.json is updated by CI after create-release succeeds — never manually. This ensures the download website only points to published artifacts.
Common Mistakes
| Mistake | Fix |
|---|---|
| Pushing tag before pushing main | Always git push origin main first. A tag on an unpushed commit won't trigger CI on the right SHA. |
| Hardcoding version in RELEASE_BODY.md | Use __VERSION__ placeholder. The CI substitutes it automatically. |
| Releasing with uncommitted changes | git status --short must be empty. Uncommitted changes won't be included in the release. |
Letting CI update docs/version.json |
version.json is updated by CI's create-release job after artifacts are published. Do NOT update it manually in the release commit. |
Forgetting to regenerate Cargo.lock |
After editing Cargo.toml version, run cargo check --manifest-path src-tauri/Cargo.toml to sync Cargo.lock. sed alone won't update it. |
| Making multiple commits | All version updates (CHANGELOG, Cargo.toml, Cargo.lock, package.json) go into a single chore: release vX.Y.Z commit. Do not commit after each file. docs/version.json is not part of this commit — CI handles it. |