/release-candidate cuts a release by orchestrating the existing gitflow release mechanic (start from develop; finish fan-out main+develop+delete) and adding the one piece the lib lacks: the version tag. - skills/release-candidate/SKILL.md: thin orchestrator — preconditions → gitflow start release → prep (version.txt + CHANGELOG, breaking doc'd) → run-tests gate → human WHEN-to-release gate → gitflow finish → git tag -a vX.Y.Z (in the skill, lib untouched) → push (gated). - lib/tests/run-release-candidate.sh: throwaway-repo flow replay. RC_TAG=0 reds the tag (gitflow fans out but never tags); RC_TAG=1 → 5/5. - CLAUDE.md: Skill routing line. CHANGELOG [Unreleased]: /reconcile + /release-candidate under Added (so the eventual v4.0.0 captures them). Tag scheme vX.Y.Z continues the version.txt/CHANGELOG lineage. writing-skills TDD. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C6bUdvHnajCNzgVQefZowj
3.8 KiB
/release-candidate — cut a gitflow release (orchestrator)
Overview
Turns the accumulated work on develop into a tagged release on main. THIN ORCHESTRATOR over lib/gitflow.sh: the lib does the generic fan-out (release branch → main + back to develop + delete the branch); the skill adds what the lib deliberately does not know — the version number, the CHANGELOG, the human "is it time?" gate, and the git tag.
Division of labour (lib = mechanic, skill = judgment): the tag lives HERE, not in gitflow.sh, because it is release-specific (version + message + human decision) while the lib's fan-out is generic. Consequence (accepted): a release cut by calling gitflow finish directly, bypassing this skill, fans out but is NOT tagged — /release-candidate is the canonical release path.
When to use
developis ahead ofmainand you want to publish a version.- "cut a release", "release candidate", "tag a version", "ship develop to main".
Not for: integrating a feature/bugfix → gitflow finish (via /ship-feature). A prod emergency fix off main → hotfix (different fan-out).
Versioning
- Tag scheme
vX.Y.Z(semver, v-prefix — Gitea/GitHub release convention). Continues theversion.txt+ CHANGELOG lineage (the repo's authority); never restart at v1.0.0 (desyncs from a CHANGELOG already at 3.x+). - The number DERIVES from the change nature (semver), not the reverse: a migration-requiring/breaking change → MAJOR; new features → MINOR; fixes → PATCH. Personal repo ⇒ "breaking" = requires a migration of your own usage. Decide the number BEFORE running.
Flow
REQUIRED: lib/gitflow.sh (the release mechanic). Clean tree, identity set, develop ahead of main.
- Preconditions — clean tree, git identity,
developahead ofmain(else nothing to release). gitflow start release <X.Y.Z>— forks from develop, lands onrelease/<X.Y.Z>.- Prep on the release branch:
version.txt→<X.Y.Z>.- CHANGELOG:
## [Unreleased]→## [<X.Y.Z>] — <date>, re-open an empty[Unreleased]. A MAJOR must spell out its breaking change (### Changed/### Removed/BREAKING); review the doc-syncer draft for completeness. - Any release-candidate fixes; commit the prep on the branch.
- Run the test suite (
lib/tests/*, gitflow-test) — RC gate; never release red.
- HUMAN GATE — WHEN to release. STOP. Proceed only on an explicit human go (mirror /ship-feature's finish gate). Never fire on "tests pass".
gitflow finish— lib fans out: mergerelease/*→main, merge-back→develop, delete the branch.- Tag (the piece the lib lacks):
git tag -a v<X.Y.Z> main -m "release <X.Y.Z>"— annotated, on main's release-merge commit, AFTER finish. - Push — GATED (ASK). On explicit go only (LRN-069):
git push origin main develop && git push origin v<X.Y.Z>.
Common mistakes
- Tagging before
gitflow finish→ tag wouldn't sit on main's merge commit. Tag AFTER, on main. - Auto-firing finish because tests pass → finish is a HUMAN gate.
- Restarting the tag at v1.0.0 → desyncs from the CHANGELOG lineage. Continue it.
- Pushing without the ASK gate → LRN-069.
Validation
RC_WORK=$(mktemp -d) RC_TAG=1 bash lib/tests/run-release-candidate.sh → 5/5 (fan-out + tag on main). RC_TAG=0 reds the tag assertion — proves the lib alone never tags (the gap this skill fills).