SuperAPI AI 工具集

changelog-generator

编程与开发

查看项目

更新于 11-13 06:22

技能介绍

Changelog Generator 是一个 Claude 技能,用于自动把 Git 提交历史整理成面向用户的更新日志。

用途:它适合在准备新版本发布说明、编写每周或每月产品更新摘要、为客户记录变更、撰写应用商店提交用的更新说明、生成更新通知、制作内部发布文档,以及维护公开的更新日志或产品更新页面时使用。

主要能力:该技能会扫描 Git 历史,可按日期范围、两个版本标签之间或最近 N 次提交来获取记录。随后把提交归入新功能、改进、缺陷修复、破坏性变更和安全更新等类别,并跳过重构、测试、构建、文档和杂务类内部提交。它还会把开发者语言改写为用户能理解的内容,例如把“添加 OAuth2 认证提供方”转换为“支持使用 Google、GitHub 或 Microsoft 账户登录”,把“为图片组件实现懒加载”转换为“滚动时图片加载更快”,把“修复同步 worker 中的竞态条件”转换为“解决了同步可靠性问题”。输出时按类别分组并配以图标,使用带粗体标题的列表项,补充用户收益的简要说明,并附上版本号和日期。它强调以用户影响而非实现细节为中心,使用主动语态和现在时,并去掉 API、SDK、重构等技术术语。

使用方式:需要在项目仓库根目录运行。可按日期范围生成,例如用 git log --oneline --since="<date>" 获取;也可按版本区间生成,例如 git log --oneline <tag1>..<tag2>;还可查看最近若干次提交,例如 git log --oneline -n <number>。用户可以提出“从上次发布以来的提交创建更新日志”“为过去一周的所有提交生成更新日志”“为 2.5.0 版本创建发布说明”“为 3 月 1 日到 3 月 15 日之间的提交创建更新日志”等请求,也可指定使用 CHANGELOG_STYLE.md 中的格式指南来保持风格一致。生成结果可保存到 CHANGELOG.md,发布前建议人工审核和调整。

适用场景:包括创建 GitHub 发布说明、撰写应用商店更新描述、生成发给用户的邮件更新、制作社交媒体公告帖,以及维护公开更新日志页面。

限制:该技能依赖 Git 仓库和提交历史,需在仓库根目录执行;分类和改写基于提交关键词及规则,可能遗漏用户可感知的变更或误判类别,因此输出需人工复核。资料未提供收费、价格、平台支持范围或效果保证等信息。