SuperAPI AI 工具集

release-notes-generator

部署与运维

查看项目

更新于 10-15 21:42

技能介绍

用途:从 git 提交历史生成发布说明,输出三种格式:面向开发者的 CHANGELOG.md 章节、半技术化的 PR 发布正文、面向用户的产品化 Slack 公告。

主要能力:分析自上次发布标签或指定版本以来的提交;通过 gh api 获取 PR 标题、描述与标签;按约定式提交前缀将变更归类为功能、修复、性能、安全、架构、维护等;检测数据库迁移文件并醒目提示;将技术术语转换为产品语言(如 N+1 查询优化→更快的列表加载)。

使用方式:在仓库根目录运行,需已认证 gh CLI。支持按上次发布、指定版本(如 0.18.0)或版本区间(v0.17.0 到 HEAD)生成,可用 --preview 仅预览不写文件。常用命令:git tag --sort=-v:refname | head -n 1 获取最近标签;git log <tag>..HEAD --oneline --no-merges 列出提交;gh api repos/{owner}/{repo}/pulls/{number} 获取 PR 详情;git diff <last-tag>..HEAD --name-only -- migrations/ 检测新迁移。

适用场景:配合发布流程,生成 PR develop→main、更新 CHANGELOG、打标签并发布 Slack 公告。

限制:依赖约定式提交前缀与 gh CLI 认证;生成内容需人工复核;具体模板与映射规则见其 assets 与 references 文件。