Agent Skills
返回列表
💻

git-cliff 定制变更日志生成器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/git-cliff-changelog-generator。

技能介绍

要解决的具体问题

团队维护 CHANGELOG.md 时,手工整理提交记录既耗时又容易遗漏。提交信息风格不统一时,人工归类 commit 的工作量随仓库规模线性增长;不同成员写出的条目格式往往不一致,最终导致 changelog 可读性差、release 说明难以评审,有时甚至与实际提交历史脱节。

核心能力与工作流程

git-cliff 直接从 Git 历史中提取提交,分两个层次处理:

  • 内置 conventional commits 解析:识别 feat:、fix: 等约定式前缀,自动完成类型归类,并提取关联的 issue 引用。
  • 正则自定义解析器:对不符合约定式规范的历史仓库,可用正则匹配自定义的消息格式,适配既有提交习惯。

解析完成后,通过 TOML 配置文件(如 cliff.toml)定制输出模板,控制提交分组、过滤规则和渲染格式。生成的变更日志可接入 GitHub Actions、Docker 镜像构建或 CI/CD 流水线,在发版流程中自动产出 CHANGELOG.md,不需要额外写脚本。

适用边界与注意点

  • 提交历史需要大致可解析;完全混乱的提交信息即使配合正则,归类结果也不稳定。
  • TOML 模板和正则规则需要针对仓库实际的消息风格调校,首次接入要花时间调试。
  • 工具只负责按规则生成日志,不会强制仓库改用 conventional commits 规范。

使用场景

  • 开源项目需要从 Git 提交历史中自动生成 CHANGELOG.md,供 release 发布说明使用,避免手动整理提交记录
  • 团队采用 conventional commits 但需要按自定义规则对提交分组并调整输出格式,例如把不同类型的 commit 归类到不同章节
  • CI/CD 流水线需要在每次发版时自动生成变更日志并附带上个版本以来的提交记录,支持 GitHub Actions 或 Docker 构建流程
  • 历史项目提交信息不符合 conventional commits,希望通过正则表达式自定义解析规则以适配现有提交风格

适合人员

  • 开源项目维护者,需要为每次 release 生成清晰的变更记录供社区查看和评审
  • 后端开发工程师,团队采用 conventional commits 但需要统一 CHANGELOG.md 的输出格式与分组规则
  • DevOps 工程师,需要将变更日志生成集成到 CI/CD 流水线中实现自动化发布流程
  • 技术负责人,需要规范团队提交信息风格并通过工具自动产出可读的变更日志