mcpField
R
release-check

release-check

github.com/drillan测试与质量353 次安装40 周前更新
代码仓库

关于 release-check

用于手动检查项目是否具备发布条件的技能。它生成清单，核验必要产物、文档、版本一致性和 API 文档，并列出问题与就绪状态。

主要功能

  1. 01检查规格文档产物是否完整
  2. 02检查 README 与更新日志
  3. 03核对包版本与更新日志版本
  4. 04检查 API 文档
  5. 05输出就绪状态和问题详情

适用场景

  1. 01发布前检查就绪情况
  2. 02查找缺失的项目必需产物
  3. 03核验版本与 API 文档的一致性

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/drillan/speckit-gates --skill release-check

安装后在 Claude Code 中输入/release-check确认已加载。

附带文件scripts/check.sh

详细介绍

release-check

在创建版本发布前验证发布就绪情况。

目的

此技能用于验证所有制品是否完整且一致，适合发布：

  • Spec kit 制品：spec.md、plan.md、tasks.md 均存在且内容完整
  • 文档：README.md、CHANGELOG.md 包含必需章节
  • 版本管理：package.json 和 CHANGELOG 中的版本号一致
  • API 文档：API 文档与契约规范一致

输出

此技能输出一份 ReleaseChecklist，其中包含：

  • 总体就绪状态（Ready/Not Ready）
  • 各项检查及其通过/失败/跳过状态
  • 版本一致性信息
  • 发布前需要解决的具体问题

用法

这是一项手动技能——创建版本发布前运行：

npx skills run release-check

或通过 AI Agent 运行：

User: Check if we're ready for release

退出代码

代码状态含义
0Ready所有检查均通过
1Not Ready部分检查未通过
3Error缺少必需文件

执行的检查

制品检查 (FR-022)
检查要求
spec.md 存在必需
plan.md 存在必需
tasks.md 存在必需
所有任务均已完成必需
文档检查 (FR-023)
检查要求
README.md 存在必需
README.md 包含用法章节必需
CHANGELOG.md 存在必需
CHANGELOG.md 包含未发布章节必需
版本检查 (FR-026)
检查要求
package.json 中存在版本号可选
CHANGELOG.md 中存在版本号可选
版本号一致若两者均存在
API 检查 (FR-025)
检查要求
contracts/ 存在可选
存在契约时需有 API 文档存在契约时必需
端点已记录存在契约时必需

检查清单输出格式

## Release Checklist

**Status**: Ready to Release / Not Ready

### Artifacts
| Status | Check | Details |
|--------|-------|---------|
| [PASS] | spec.md exists | |
| [PASS] | plan.md exists | |
| [FAIL] | All tasks complete | 5 tasks remaining |

### Documentation
| Status | Check | Details |
|--------|-------|---------|
| [PASS] | README.md exists | |
| [SKIP] | API docs | No contracts/ directory |

建议

如果发布检查未通过：

  1. 完成 tasks.md 中所有剩余任务
  2. 确保 README.md 包含用法章节
  3. 在 CHANGELOG.md 中更新发布说明
  4. 确认版本号一致
  5. 再次运行 release-check，验证修复结果

评论

支持 Markdown