SuperAPI AI 工具集

changelog-generator

通用与其它

查看项目

更新于 10-16 08:45

技能介绍

用途:把技术性的 Git 提交转换为用户能看懂的更新日志,适用于准备新版本发布说明、周报或月报式产品更新、面向客户的变更文档、应用商店更新描述、更新通知、内部发布文档以及公开的产品更新页面。

主要能力:扫描指定时间段或版本之间的 Git 历史;将提交归类为功能、改进、缺陷修复、破坏性变更、安全等逻辑分组;把开发者语言翻译成面向客户的语言;按规范格式输出结构化条目;过滤重构、测试等内部噪音提交;可结合自定义风格指南与品牌语气。

使用方式:在项目仓库根目录运行。基本用法包括“根据上次发布以来的提交创建更新日志”“为过去一周的所有提交生成更新日志”“为 2.5.0 版本创建发布说明”。可指定日期范围,例如“为 3 月 1 日至 3 月 15 日之间的所有提交创建更新日志”。也可引用自定义规范,例如“根据 v2.4.0 以来的提交创建更新日志,使用 CHANGELOG_STYLE.md 中的更新日志规范”。

输出示例结构包含标题(如“# Updates - Week of March 10, 2024”)、新功能、改进、修复等分节,条目以加粗名称加说明的形式呈现。

建议:从 Git 仓库根目录运行;用日期范围聚焦内容;用 CHANGELOG_STYLE.md 保持格式一致;发布前人工审阅调整;可将输出直接保存到 CHANGELOG.md。相关场景还包括生成 GitHub 发布说明、应用商店更新描述、用户邮件更新和社交媒体公告。

限制:资料未提供具体安装命令、支持的平台、收费方式或价格信息,暂未提供。