SuperAPI AI 工具集

changelog-generator

写作与研究

查看项目

更新于 10-15 23:41

技能介绍

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

主要能力:扫描指定时间段或版本之间的 Git 历史;将提交归入功能、改进、Bug 修复、破坏性变更、安全等逻辑分类;把开发者提交翻译成用户可理解的语言;按规范格式输出结构化条目;过滤重构、测试等内部噪音提交;可遵循更新日志规范与品牌语气。

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

示例输出结构:标题为“Updates - Week of March 10, 2024”,下设“✨ New Features”“🔧 Improvements”“🐛 Fixes”等分类,每条以加粗名称加简短说明呈现。

提示:从 Git 仓库根目录运行;指定日期范围以获得聚焦的更新日志;使用 CHANGELOG_STYLE.md 保持格式一致;发布前审阅并调整生成内容;可将输出直接保存到 CHANGELOG.md。

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