Git-Cliff项目中预发布版本变更日志生成机制解析

在软件开发过程中，版本管理是一个至关重要的环节，特别是当项目采用语义化版本控制(SemVer)时，预发布版本(如rc、alpha、beta等)的管理尤为重要。Git-Cliff作为一款优秀的变更日志生成工具，提供了灵活的配置选项来处理预发布版本的变更记录。

预发布版本变更日志的生成挑战

在实际开发中，我们通常会遇到这样的版本发布序列：2.0 → 2.1-rc.0 → 2.1-rc.1 → 2.1。对于这种场景，开发者期望变更日志能够体现：

1. 从2.0到2.1-rc.0的变更
2. 从2.1-rc.0到2.1-rc.1的变更
3. 从2.0直接到2.1的完整变更

这种需求反映了开发过程中常见的版本演进路径：从稳定版本出发，经过若干预发布版本的迭代，最终达到新的稳定版本。

Git-Cliff的解决方案

Git-Cliff通过两个关键配置参数来处理预发布版本：

skip_tags参数

skip_tags采用正则表达式匹配需要完全跳过的标签。例如配置skip_tags = "beta|alpha"时：

• 所有匹配beta或alpha的标签将被完全忽略
• 这些标签对应的提交不会出现在变更日志中
• 不影响其他非跳过标签的提交处理

ignore_tags参数

ignore_tags同样采用正则表达式，但处理方式不同。例如配置ignore_tags = "rc"时：

• 匹配rc的标签本身会被忽略
• 但这些标签对应的提交会被合并到下一个非忽略标签的变更集中
• 影响所有提交，包括未打标签的提交

实际应用示例

假设有以下版本发布历史： v0 → v1-alpha → v1-beta → v1-rc.0 → v1

使用配置：

skip_tags = "beta|alpha"
ignore_tags = "rc"

处理结果将是：

• alpha和beta版本的变更完全不出现在日志中
• rc版本的变更会被归入v1版本的变更集
• 最终变更日志将展示从v0到v1的所有相关变更

最佳实践建议

1. 对于内部测试版本(alpha/beta)，建议使用skip_tags完全跳过，避免污染正式变更日志
2. 对于候选发布版本(rc)，建议使用ignore_tags，保留变更记录但合并到最终版本
3. 对于复杂的版本管理需求，可以组合使用这两个参数实现精细控制
4. 定期检查生成的变更日志，确保符合项目发布策略

Git-Cliff的这种设计既保持了变更日志的整洁性，又确保了重要变更的完整记录，是项目版本管理的有力工具。