release
Bump the version in every manifest, update the changelog, tag main and publish a GitHub release marked latest.
- License 许可
- MIT
- 最近更新
- 2026-10-16
- Stars
- ★ 2
- Forks
- 0
01 前言 Front Matter
- name
- release
- description
- Bump the version in every manifest, update the changelog, tag main and publish a GitHub release marked latest.
- disable-model-invocation
- true
03 SKILL.md 正文
Release
One version names the whole release. It lives in exactly these places:
crates/software-design/Cargo.toml(version = "…"under[package]; the launcher reads it)Cargo.lock(thesoftware-designpackage entry; cargo rewrites it).claude-plugin/plugin.json,.codex-plugin/plugin.json,package.json("version")CHANGELOG.md(a## X.Y.Zheading)
The internal crates (history, rules, syntax) stay at 0.0.0: they are unpublished. tests/tidy.rs::every_version_names_the_same_release enforces the manifests agree.
1. Preconditions
Stop and tell the user if any fails:
git status --porcelainis empty and the branch ismain.git fetch origin && git status -sbshows main is not behindorigin/main.gh auth statussucceeds.
2. Propose the bump
- Current version: from
crates/software-design/Cargo.toml. - Last release:
git describe --tags --abbrev=0(none yet → everything since the first commit). - Read
git log <last-tag>..HEAD --onelineand the diff stat. Classify:- major: removed or renamed skill/agent/MCP tool/CLI flag, changed JSON output schema (
SCHEMA_VERSION), changed hook behavior users rely on. While on0.x, a breaking change bumps minor. - minor: new rule, skill, agent, tool, language or option.
- patch: fixes, docs, internal refactors only.
- major: removed or renamed skill/agent/MCP tool/CLI flag, changed JSON output schema (
- Ask the user with AskUserQuestion: options patch / minor / major, each label showing the resulting version, the recommended one first with "(Recommended)" and a one-line reason drawn from the commits. Do not continue without an answer.
3. Bump
- Replace the old version with the new one in the three JSON manifests and in
crates/software-design/Cargo.toml(the[package]versionline only — never dependency versions). - Add
## X.Y.Zat the top ofCHANGELOG.md(under# Changelog), with terse bullets in the existing style summarising user-visible changes since the last tag. Show it to the user and apply their edits. - Run the CI checks; they also refresh
Cargo.lock:cargo fmt --all --check && cargo clippy --workspace --all-targets -- -D warnings && cargo test --workspace - Confirm alignment:
git grep -n "X.Y.Z"lists every file above, andgit diff --stattouches nothing else besidesCargo.lock.
4. Commit, tag, push
Show the diff and get an explicit yes before pushing.
git commit -am "Release X.Y.Z"
git tag -a vX.Y.Z -m "X.Y.Z"
git push origin main vX.Y.Z
5. GitHub release
Notes are the ## X.Y.Z section of CHANGELOG.md (without the heading):
awk '/^## /{p = ($2 == "X.Y.Z"); next} p' CHANGELOG.md > "$TMPDIR/notes.md"
gh release create vX.Y.Z --verify-tag --title "X.Y.Z" --notes-file "$TMPDIR/notes.md" --latest
Then gh release list --json tagName,isLatest --jq '.[] | select(.isLatest) | .tagName' must print vX.Y.Z; give the user the URL from gh release view vX.Y.Z --json url.
04 同仓库更多 Skills
review
Reviews code for design red flags, such as shallow modules, pass-through methods, information leakage, repeated code, comments that repeat code, vague names and ignored errors, and tests whether public interfaces can be used without reading their implementation. Ranks findings by how often the code changes and verifies each against the rule's own exemptions. Use when the user asks to review a diff, branch, pull request, file or directory for design quality, complexity or maintainability, asks whether code is well designed, or asks whether an API, class or module is clear or usable without reading its code.
perf
Make code faster without making it more complex. Measures before changing anything, looks for a fundamental fix first, and otherwise redesigns around the critical path with special cases moved off it. Use when the user asks to optimise, speed up, or reduce the latency, allocations or memory of code, or to review a change made for performance. Use it even when the user names a specific micro-optimisation, because measuring comes first.
document
Write or improve the interface and implementation comments of a module. Comments carry what the code cannot say (units, boundaries, invariants, errors, reasons) and never repeat the code. A comment that is hard to write is reported as a design problem. Use when the user asks to document, comment or explain a module, class, function or API, to fix poor or outdated comments, or when the software-design hooks report comments that repeat the code. Use it even when the user only asks to add comments or docstrings.
design
Designs the interface of a new class, module, API, service or feature before its code is written. Lists the knowledge the module hides, designs three competing interfaces in parallel, tests each on a reader who has never seen the code, compares the caller code each needs, and writes interface comments first. Use whenever the user asks to design, sketch, shape, structure or plan a class, module, API, interface or service, asks which methods or signatures something should have, wants to compare designs, or says "design it twice", even when they only describe what the code must do. Typical requests include "design the class interface", "what methods should this class have", "how should I structure this module", "sketch an API for", "design X before I write it", or any description of a class, module or API that does not exist yet.
change
Plan a change to existing code strategically. Before editing, works out what the code would look like had it been designed with this change in mind, compares that with the smallest patch, and lets the user choose. After editing, checks the diff for red flags and stale comments. Use when the user asks to add a feature to, fix, or extend existing code and the change adds a parameter, flag, special case or exception, touches a module's interface, or spreads across several files. Use it even when the request sounds like a small patch, because small patches are how complexity accumulates.
audit
Audit a whole repository or a large directory for design complexity. Ranks red flags by how often each file changes, verifies candidates against each rule's exemptions in parallel, has a cold reader judge the interfaces of the most-changed modules, and returns the investments worth making first. Use when the user asks for an audit, a design or complexity review of an entire codebase or package, a hotspot map, or where design work would pay off most. Use it even when the user only asks where the code is worst or what to clean up first.