mcpField
R
release-checklist

release-checklist

github.com/yonatangrossDevelopment300133 installsUpdated today
Repository

About release-checklist

A sequential release checklist for OrchestKit maintainers handling builds, tests, and release commits. It stops at the first failure and resumes after the user confirms a fix.

Key features

  1. 01Run pre-release checks in order
  2. 02Validate build, tests, and security
  3. 03Check counts and diffs
  4. 04Verify changelog and version updates
  5. 05Guide staging, commits, tags, and pushes

Use cases

  1. 01Run release gates before a commit
  2. 02Fix a failed check and resume the release
  3. 03Confirm version files and changelog are updated
  4. 04Review and confirm before pushing

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/yonatangross/orchestkit --skill release-checklist

After installing, type/release-checklistin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

test-cases.json
references/
release-flow.md
rules/
_sections.md
_template.md
commit-staging.md
commit-tag-push.md
gate-build-and-test.md
gate-counts-and-diff.md
scripts/
pre-push-confirm.sh

Details

From the project README

Release Checklist

Sequential release gate for OrchestKit. Each step reports [PASS] or [FAIL]. Stop on first failure, suggest a fix, then continue after user confirmation.

Load details: Read("${CLAUDE_SKILL_DIR}/references/release-flow.md") for why the order matters and hotfix guidance.

CC ≥ 2.1.118 (M122): Pre-release gate now includes claude plugin tag <version> --dry-run to validate the manifest hierarchy. Add to the gate sequence after manifest count checks. See src/skills/chain-patterns/references/plugin-tag.md.

Quick Reference

CategoryRulesImpactWhen to Use
Pre-Release Gates2CRITICALBefore every release commit
Release Commit2HIGHStaging, committing, tagging, pushing

Total: 4 rules across 2 categories

Quick Start

# Run all pre-release gates in order (stop on first failure)
npm run build && npm test && npm run test:security && npm run typecheck
bash src/skills/validate-counts/scripts/validate-counts.sh
git diff  # review before staging

Pre-Release Gates

Must all pass before writing any release commit. See rules/gate-build-and-test.md and rules/gate-counts-and-diff.md.

StepCommandRule File
1. Buildnpm run buildrules/gate-build-and-test.md
2. Testsnpm testrules/gate-build-and-test.md
3. Securitynpm run test:securityrules/gate-build-and-test.md
4. TypeScriptnpm run typecheckrules/gate-build-and-test.md
5. Validate counts/validate-countsrules/gate-counts-and-diff.md
6. Diff reviewgit diffrules/gate-counts-and-diff.md

Release Commit

Steps after all gates pass. See rules/commit-staging.md and rules/commit-tag-push.md.

StepActionRule File
7. ChangelogEntry exists in CHANGELOG.mdrules/commit-staging.md
8. Version bumppackage.json + CLAUDE.md both updatedrules/commit-staging.md
9. Stage filesgit add <specific files> — never -Arules/commit-staging.md
10. Commitrelease: vX.Y.Z conventional formatrules/commit-tag-push.md
11. Taggit tag vX.Y.Zrules/commit-tag-push.md
12. PushRun scripts/pre-push-confirm.sh — confirm firstrules/commit-tag-push.md

Related Skills

  • validate-counts — Count consistency check (step 5 of this checklist)
  • audit-skills — Broader skill quality audit (run before major releases)
  • checkpoint-resume — Rate-limit-resilient pipelines for long release sessions

Common Mistakes

  1. Running npm test before npm run build — tests run against stale dist
  2. Using git add -A — accidentally stages secrets or unrelated in-progress work
  3. Forgetting to bump CLAUDE.md version alongside package.json
  4. Pushing without explicit user confirmation — irreversible on shared remotes
  5. Skipping security tests — non-negotiable, even for patch releases

Comments

Markdown supported