Git-Cliff 项目：基于 Pull Request 生成变更日志的最佳实践

在软件开发过程中，变更日志(Changelog)是记录项目版本间变化的重要文档。Git-Cliff 作为一个强大的变更日志生成工具，最近新增了对 Pull Request 标题解析的支持，这为团队协作开发带来了更优雅的解决方案。

传统方式的局限性

在团队协作环境中，通常会设置分支保护规则，要求必须通过 Pull Request 才能合并代码。这种情况下，传统的基于提交信息生成变更日志的方式存在几个问题：

1. 一个 Pull Request 可能包含多个提交，导致变更日志条目冗余
2. 提交信息可能不够规范，难以提取有用的分类信息
3. 开发过程中的中间提交信息可能包含不相关的细节

基于 Pull Request 的新方案

Git-Cliff 2.5.0 版本引入了对 Pull Request 标题解析的支持，开发者现在可以：

1. 直接使用 Pull Request 标题作为变更条目
2. 通过 github.pr_title 字段进行分组和分类
3. 结合 Pull Request 编号创建更丰富的变更记录

配置示例

在 Git-Cliff 配置文件中，可以这样设置：

[commit_parsers]
# 使用 Pull Request 标题进行分组
pattern = "^(feat|fix|docs|style|refactor|perf|test|chore)(\\(.+\\))?: .+"
field = "github.pr_title"
skip = false
group = "{{ captures[0] }}"
scope = "{{ captures[1] | trim_start_matches(pat='(') | trim_end_matches(pat=')') }}"

实际应用建议

1. 统一命名规范：团队应约定 Pull Request 标题的格式规范，如采用 Conventional Commits 格式
2. 标签分类：可以结合 GitHub 标签系统，在模板中根据标签进行分类展示
3. 信息丰富化：在模板中同时展示 Pull Request 编号和链接，方便追溯

优势总结

这种基于 Pull Request 的变更日志生成方式具有以下优势：

1. 更清晰的变更记录：每个功能/修复只对应一个条目
2. 更好的可读性：Pull Request 标题通常经过精心编写，比提交信息更规范
3. 方便的追溯：可以直接链接到 Pull Request 查看详细讨论和代码变更
4. 与 GitHub 流程完美契合：符合现代团队协作的开发流程

通过合理配置 Git-Cliff，团队可以生成既专业又实用的变更日志，有效提升项目文档的质量和维护效率。