Back to Details

release-check

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

release-check

release-check

Validates release readiness before creating a release.
在创建发布前验证发布就绪状态。

Purpose

用途

This skill validates that all artifacts are complete and consistent for release:
  • Spec kit artifacts: spec.md, plan.md, tasks.md exist and are complete
  • Documentation: README.md, CHANGELOG.md have required sections
  • Versioning: Version numbers are consistent across package.json and CHANGELOG
  • API docs: API documentation matches contract specifications
本Skill用于验证所有用于发布的工件是否完整且一致：
  • Spec Kit工件：spec.md、plan.md、tasks.md已存在且内容完整
  • 文档：README.md、CHANGELOG.md包含必填章节
  • 版本控制：package.json与CHANGELOG中的版本号保持一致
  • API文档：API文档与契约规范匹配

Output

输出

The skill outputs a ReleaseChecklist with:
  • Overall readiness status (Ready/Not Ready)
  • Individual check items with pass/fail/skip status
  • Version consistency information
  • Specific issues to address before release
本Skill会输出一份ReleaseChecklist，包含：
  • 整体就绪状态（就绪/未就绪）
  • 各项检查项的通过/失败/跳过状态
  • 版本一致性信息
  • 发布前需要解决的具体问题

Usage

使用方法

This is a manual skill - run it before creating a release:
bash
npx skills run release-check
Or via AI agent:
User: Check if we're ready for release
这是一个手动执行的Skill - 在创建发布前运行：
bash
npx skills run release-check
或通过AI Agent调用：
用户：检查我们是否已准备好发布

Exit Codes

退出码

CodeStatusMeaning
0ReadyAll checks pass
1Not ReadySome checks failed
3ErrorRequired files missing
代码状态含义
0就绪所有检查项通过
1未就绪部分检查项失败
3错误缺少必要文件

Checks Performed

执行的检查项

Artifact Checks (FR-022)

工件检查（FR-022）

CheckRequirement
spec.md existsRequired
plan.md existsRequired
tasks.md existsRequired
All tasks completeRequired
检查项要求
spec.md存在必填
plan.md存在必填
tasks.md存在必填
所有任务已完成必填

Documentation Checks (FR-023)

文档检查（FR-023）

CheckRequirement
README.md existsRequired
README.md has usage sectionRequired
CHANGELOG.md existsRequired
CHANGELOG.md has unreleased sectionRequired
检查项要求
README.md存在必填
README.md包含使用章节必填
CHANGELOG.md存在必填
CHANGELOG.md包含未发布章节必填

Version Checks (FR-026)

版本检查（FR-026）

CheckRequirement
package.json version presentOptional
CHANGELOG.md version presentOptional
Versions matchIf both present
检查项要求
package.json中存在版本号可选
CHANGELOG.md中存在版本号可选
版本号匹配若两者均存在则需满足

API Checks (FR-025)

API检查（FR-025）

CheckRequirement
contracts/ existsOptional
API docs exist if contractsRequired if contracts
Endpoints documentedRequired if contracts
检查项要求
contracts/目录存在可选
若存在契约则需有API文档若存在契约则必填
所有端点已文档化若存在契约则必填

Checklist Output Format

检查清单输出格式

undefined
undefined

Release Checklist

Release Checklist

Status: Ready to Release / Not Ready
状态：可发布 / 未就绪

Artifacts

工件

StatusCheckDetails
[PASS]spec.md exists
[PASS]plan.md exists
[FAIL]All tasks complete5 tasks remaining
状态检查项详情
[通过]spec.md存在
[通过]plan.md存在
[失败]所有任务已完成剩余5项任务

Documentation

文档

StatusCheckDetails
[PASS]README.md exists
[SKIP]API docsNo contracts/ directory
undefined
状态检查项详情
[通过]README.md存在
[跳过]API文档无contracts/目录
undefined

Recommendations

建议

If release check fails:
  1. Complete all remaining tasks in tasks.md
  2. Ensure README.md has a usage section
  3. Update CHANGELOG.md with release notes
  4. Verify version numbers are consistent
  5. Run release-check again to verify fixes
若发布检查失败：
  1. 完成tasks.md中所有剩余任务
  2. 确保README.md包含使用章节
  3. 更新CHANGELOG.md并添加发布说明
  4. 验证版本号是否一致
  5. 重新运行release-check以确认问题已修复