SuperAPI AI 工具集

changelog-generator

写作与研究

查看项目

更新于 10-19 16:18

技能介绍

用途

Changelog Generator 的核心用途是将开发者视角的 Git 提交历史,转化为普通用户能够理解和欣赏的更新日志。它适合在以下时机使用:为新版本准备发布说明;创建每周或每月的产品更新摘要;为客户记录变更内容;为应用商店提交编写更新描述;生成更新通知;编写内部发布文档;维护公开的变更日志或产品更新页面。

主要能力

  • 扫描 Git 历史:分析特定时间段内或版本之间的提交记录。
  • 分类变更:将提交按逻辑归入功能、改进、问题修复、破坏性变更、安全等类别。
  • 技术语言转用户语言:把开发者提交信息改写为面向客户的自然表达。
  • 专业格式化:生成干净、结构清晰的更新日志条目。
  • 过滤噪音:排除重构、测试等内部提交,不将其呈现给用户。
  • 遵循最佳实践:应用变更日志编写准则与品牌语气。

使用方式

基本用法是在项目仓库中直接触发,例如:根据上次发布以来的提交创建变更日志;为过去一周的所有提交生成变更日志;为版本 2.5.0 创建发布说明。也可以指定日期范围,例如为 3 月 1 日至 3 月 15 日之间的所有提交生成变更日志。若需统一格式,可引用自定义准则文件,例如:根据 v2.4.0 以来的提交创建变更日志,并使用 CHANGELOG_STYLE.md 中的变更日志准则。

示例

用户提出“为过去 7 天的提交创建变更日志”后,输出会以周为单位组织,分为“✨ 新增功能”“🔧 改进”“🐛 修复”等小节,每条用用户能理解的语言描述,例如“团队工作区:为不同项目创建独立工作区,邀请团队成员并保持条理”“更快的同步:文件跨设备同步速度提升 2 倍”“修复大图片无法上传的问题”等。

适用场景

除直接生成变更日志外,还适用于创建 GitHub 发布说明、编写应用商店更新描述、生成面向用户的邮件更新、制作社交媒体公告帖等。

限制与注意事项

使用时应从 Git 仓库根目录运行;建议指定日期范围以获得聚焦的变更日志;可通过 CHANGELOG_STYLE.md 保持格式一致;生成结果在发布前应人工审核和调整;输出可直接保存到 CHANGELOG.md。资料未提供该技能的安装命令、平台依赖、收费模式或效果保证等更多信息。