release-checklist

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

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.
See references/release-flow.md for why the order matters and hotfix guidance.
OrchestKit的顺序发布关卡。每个步骤会返回
[PASS]
[FAIL]
。遇到首个失败时停止,建议修复方案,待用户确认后再继续。
详情请参阅references/release-flow.md了解步骤顺序的重要性以及热修复指导。

Quick Reference

快速参考

CategoryRulesImpactWhen to Use
Pre-Release Gates2CRITICALBefore every release commit
Release Commit2HIGHStaging, committing, tagging, pushing
Total: 4 rules across 2 categories
分类规则影响级别使用场景
发布前关卡2关键每次发布提交前
发布提交2暂存、提交、打标签、推送时
总计:2个分类下共4条规则

Quick Start

快速开始

bash
undefined
bash
undefined

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
undefined
npm run build && npm test && npm run test:security && npm run typecheck bash src/skills/validate-counts/scripts/validate-counts.sh git diff # 暂存前先查看差异
undefined

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. Build
npm run build
rules/gate-build-and-test.md
2. Tests
npm test
rules/gate-build-and-test.md
3. Security
npm run test:security
rules/gate-build-and-test.md
4. TypeScript
npm run typecheck
rules/gate-build-and-test.md
5. Validate counts
/validate-counts
rules/gate-counts-and-diff.md
6. Diff review
git diff
rules/gate-counts-and-diff.md
在编写任何发布提交前必须全部通过。请查看
rules/gate-build-and-test.md
rules/gate-counts-and-diff.md
步骤命令规则文件
1. 构建
npm run build
rules/gate-build-and-test.md
2. 测试
npm test
rules/gate-build-and-test.md
3. 安全检测
npm run test:security
rules/gate-build-and-test.md
4. TypeScript检查
npm run typecheck
rules/gate-build-and-test.md
5. 验证计数
/validate-counts
rules/gate-counts-and-diff.md
6. 差异审查
git diff
rules/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.md
rules/commit-staging.md
8. Version bump
package.json
+
CLAUDE.md
both updated
rules/commit-staging.md
9. Stage files
git add <specific files>
— never
-A
rules/commit-staging.md
10. Commit
release: vX.Y.Z
conventional format
rules/commit-tag-push.md
11. Tag
git tag vX.Y.Z
rules/commit-tag-push.md
12. PushRun
scripts/pre-push-confirm.sh
— confirm first
rules/commit-tag-push.md
所有关卡通过后的步骤。请查看
rules/commit-staging.md
rules/commit-tag-push.md
步骤操作规则文件
7. 变更日志
CHANGELOG.md
中存在对应条目
rules/commit-staging.md
8. 版本升级
package.json
CLAUDE.md
均已更新
rules/commit-staging.md
9. 暂存文件
git add <指定文件>
— 切勿使用
-A
rules/commit-staging.md
10. 提交使用
release: vX.Y.Z
的约定式格式
rules/commit-tag-push.md
11. 打标签
git tag vX.Y.Z
rules/commit-tag-push.md
12. 推送运行
scripts/pre-push-confirm.sh
— 先确认再推送
rules/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
  • validate-counts
    — 计数一致性检查(本清单的第5步)
  • audit-skills
    — 更全面的技能质量审计(重大发布前运行)
  • checkpoint-resume
    — 适用于长时发布会话的、可应对速率限制的流水线

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
  1. npm run build
    前运行
    npm test
    — 测试会基于过时的dist文件执行
  2. 使用
    git add -A
    — 意外暂存密钥或无关的进行中工作内容
  3. 忘记同步升级
    CLAUDE.md
    package.json
    的版本
  4. 未经过用户明确确认就推送 — 在共享远程仓库上此操作不可逆
  5. 跳过安全检测 — 即便是补丁版本也不可省略