工程开发
release-notes-generator avatar

release-notes-generator

自动化 Git 提交记录发布说明生成工具。自动分类变更内容,将技术语言转换为用户友好的信息,并支持生成 CHANGELOG.md、PR 说明与 Slack 公告。

简介

发布说明生成器 (Release Notes Generator) 是一款专门为简化软件发布流程而设计的自动化工具,能将原始的 git 提交记录转换为结构化且具有高度参考价值的说明文档。对于希望在不增加手动撰写负担的情况下,与利益相关者、产品经理及终端用户保持高质量沟通的开发团队而言,这是理想的解决方案。通过与您的 git 工作流程及 GitHub API 直接整合,该工具可分析自上次发布标签以来的历史记录,将变更精准分类为新功能、错误修复、性能改善与安全性更新,并进一步将信息浓缩为三种格式:技术性 CHANGELOG.md、半技术性的 PR 说明主体,以及用户友好的 Slack 公告。

  • 使用 Conventional Commits 前缀(如 feat, fix, perf, security)自动分类变更内容

  • 将技术术语(例如将 'N+1 query optimization' 转换为 'Faster list loading')自动翻译为非技术人员可理解的语言

  • 通过检查 git diff 中的迁移目录来检测数据库迁移,并在控制台输出关键警示

  • 通过 gh api 获取 PR 标题、描述与标签等丰富数据,以增强内容情境

  • 确保在多个渠道中输出内容的一致性,以维护开发人员与产品团队之间的同步

  • 支持自定义 Slack 公告与 PR 发布模板

  • 于存储库根目录执行此技能,可产生自上次标签或特定版本区间以来的发布说明

  • 需配置已验证的 GitHub CLI (gh) 以访问 PR 元数据

  • 建议搭配标准化的 Conventional Commits 格式以获得最佳的分类效果

  • 提供预览模式,在将文件写入磁盘前先确认输出内容

  • 在发布至公共频道前,请务必审阅生成的内容以确保语气精确

  • 可处理复杂的输出逻辑,包含每个版本的统计数据整合(如 PR、功能与错误修正的数量)

仓库统计

Star 数
4,082
Fork 数
537
Open Issue 数
5
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月1日 07:53
在 GitHub 查看
release-notes-generator | Skills Hub