SuperAPI AI 工具集

changelog-update

通用与其它

查看项目

更新于 10-15 21:35

技能介绍

用途:在开发过程中或准备 PR 时,把文件变更整理成面向业务的 CHANGELOG.md [Unreleased] 条目,让用户理解“现在能做什么”,而不是罗列新增的类或枚举。

主要能力:按七步流程工作——用 git diff 或 git log 收集变更;在 .ai/workspace/changelog-notes-*.md 创建临时笔记;逐文件阅读 diff 并归类到 Added、Changed、Fixed、Deprecated、Removed、Security;整体回顾业务影响;按 Keep a Changelog 格式生成条目;插入 CHANGELOG.md 的 [Unreleased] 区块;最后删除临时笔记。

使用方式:先确认 CHANGELOG.md 位置,优先 ./CHANGELOG.md,其次 ./docs/CHANGELOG.md,都没有则在根目录创建。收集变更可用 git diff origin/main...HEAD --name-only、git log origin/main..HEAD --oneline 或 git show {commit} --name-only。生成条目时使用 [Unreleased] 下的模块标题与 Added/Changed/Fixed 小节。

适用场景:开发中提前记录功能或修复;PR 准备时补充业务向条目;提交信息无法完整表达业务影响时手动整理。

限制:不用于生成带版本号的发布文档,那种情况应改用 release-notes 技能;条目应避免技术术语,需体现业务影响;完成后必须删除临时笔记文件;不要在有根目录 CHANGELOG.md 时另建 docs 版本。资料未提供具体安装命令、收费或平台信息。