SuperAPI AI 工具集

wtf.changelog

通用与其它

查看项目

更新于 10-16 03:36

技能介绍

用途:在开发者合并 Feature 或关闭 Epic 后,生成发布说明或 changelog 条目。它从规格层级(Epic → Feature → 规范 Gherkin 场景)推导面向用户的表述,而非直接使用原始提交信息;Feature 正文是场景文本的权威来源,已验证 Trace 的 Scenario Claim 用于归属已交付行为,输出读起来像产品变更而非实现细节。

主要能力:识别发布范围(Feature、Epic 或日期范围);对范围内每个已关闭 Feature 或 Trace 分类为 Added、Changed、Fixed、Deprecated、Removed、Breaking;将变更翻译为面向用户的语言,使用领域角色与业务结果,避免实现词汇,并丢弃纯内部工作;按 Keep a Changelog 约定起草条目,省略无条目的章节,Epic 级超过 5 条时按 Feature 分组;与用户确认草稿;选择输出目标(更新 CHANGELOG.md、创建 GitHub Release 或两者);写入 CHANGELOG.md 并提交,或通过 gh 创建带标签的 Release。

使用方式:需先完成 GitHub CLI 设置,若 gh 未安装或未认证则停止。日期范围范围使用 gh pr list --state merged --json number,title,mergedAt,body 并配合 --jq 过滤。写入 CHANGELOG.md 时提交命令为 git add CHANGELOG.md 与 git commit -m "chore(changelog): add release notes for <scope>"。创建 Release 时先写临时文件 $NOTES,再执行 python3 .wtf/gh-body.py release <tag> --title "<release title>" --notes-file "$NOTES"。

适用场景:合并 Feature、关闭 Epic 后生成发布说明;需要面向用户而非实现细节的变更记录;需要同时更新 CHANGELOG.md 与 GitHub Release。

限制:依赖 GitHub CLI 且需已认证;依赖规格层级与 Gherkin 场景等资料;具体版本号、标签与标题由用户提供;未提供收费、价格或平台支持等信息。