SuperAPI AI 工具集

changelog-automation

编程与开发

查看项目

更新于 10-16 08:49

技能介绍

用途:把 git 提交历史与合并的 PR 自动整理成变更日志(changelog),并配合 GitHub Releases 完成版本发布。

主要能力:

  1. 约定式提交格式:<type>[optional scope]: <description>,类型包括 feat、fix、docs、refactor、test、chore、perf、breaking。规范化提交是自动化可靠的前提,可用 commitlint 在 CI 中强制。
  2. 用 git log 生成日志:按最后一次 tag 到 HEAD 输出条目,例如 git log $(git describe --tags --abbrev=0)..HEAD --pretty=format:"- %s (%h)" --no-merges;配合 grep 按 feat、fix 分组,或指定两个 tag 区间如 git log v1.0.0..v2.0.0。
  3. git-cliff(Rust 编写的 changelog 生成器):git-cliff -o CHANGELOG.md 生成完整日志;--latest 只生成最新版本;支持区间 v1.0.0..v2.0.0;--prepend CHANGELOG.md 追加到已有文件开头;--config cliff.toml 使用自定义模板。安装:cargo install git-cliff 或 brew install git-cliff。
  4. GitHub Releases:gh release create v2.0.0 --generate-notes 用自动生成说明创建发布;也可用 --title 与 --notes "$(git-cliff --latest --strip all)" 自定义;支持 --draft 草稿、--prerelease 预发布;gh release list --limit 5、gh release view v2.0.0 查看。
  5. 基于 PR 的日志:gh pr list --state merged --base main 列出已合并 PR,可按 --label feature / bug 分组输出条目。

必要用法:仓库需有规范的提交信息与一致的 semver 标签(如 v1.0.0、v1.1.0、v2.0.0);GitHub 的 --generate-notes 依赖 PR 标题与标签,因此 PR 命名需清晰。

适用场景:需要持续维护 CHANGELOG 并规范发布流程的软件项目,尤其是使用 GitHub 与约定式提交的团队。

限制与注意:草稿发布便于发布前人工审阅说明;本资料未提供具体定价、平台支持范围与效果数据。