Git-Cliff 项目中的提交消息分类问题解析

在软件开发过程中，生成清晰的变更日志(Changelog)对于项目维护至关重要。Git-Cliff 作为一款基于Git历史的变更日志生成工具，其核心功能依赖于对提交消息(commit message)的准确解析和分类。本文将深入分析一个常见的提交消息分类问题，并提供专业解决方案。

问题背景

许多开发团队会使用类似"JIRA-1234: 功能描述"或"JIRA-1234 功能描述"的格式编写提交消息。其中"JIRA-1234"代表问题跟踪系统中的工单编号。Git-Cliff默认会将这些消息分类为"conventional"(符合约定式提交规范)或"unconventional"(不符合规范)。

技术分析

Git-Cliff底层使用git-conventional库进行提交消息分析。该库将包含冒号的消息(如"JIRA-1234:...")自动识别为约定式提交，因为冒号是约定式提交的标准分隔符。而缺少冒号的消息则被标记为不符合规范。

这种自动分类可能导致以下问题：

1. 虽然格式相似，但"JIRA-1234"并非真正的约定式提交类型(type)
2. 团队可能希望统一处理所有JIRA编号开头的提交
3. 当设置filter_unconventional=false时，不符合规范的提交仍可能不出现在变更日志中

解决方案

方案一：完全禁用约定式提交解析

在配置文件(git-cliff.toml)中添加：

[git]
conventional_commits = false

这种方法简单直接，但会失去约定式提交带来的分类优势。

方案二：使用提交前处理器

更灵活的解决方案是使用提交前处理器(commit_preprocessors)统一消息格式：

commit_preprocessors = [
  { pattern = '(JIRA-\d{1,4})[\ :](.*)', replace = "${1} ${2}" }
]

这会移除JIRA编号后的冒号，使所有提交保持统一格式。

方案三：自定义提交解析器

为确保所有提交都能出现在变更日志中，需要添加兜底的提交解析器：

commit_parsers = [
  { message = ".*", group = "Other Changes" }
]

这个通配符解析器会捕获所有未被其他规则匹配的提交。

最佳实践建议

1. 逐步迁移：如果计划转向真正的约定式提交，可以分阶段实施
2. 格式统一：团队应统一使用带冒号或不带冒号的格式
3. 提交规范：考虑在项目中使用commitlint等工具强制执行提交消息规范
4. 测试验证：生成变更日志后，应人工验证内容完整性

通过合理配置Git-Cliff，团队可以灵活处理各种提交消息格式，同时为未来采用标准约定式提交做好准备。关键在于理解工具的工作原理并根据项目需求进行适当调整。