Git-Cliff 中 --with-tag-message 参数与 --tag 参数配合失效问题分析

在版本管理工具 Git-Cliff 的使用过程中，开发者发现了一个参数组合失效的问题。具体表现为当同时使用 --tag 和 --with-tag-message 参数时，虽然版本号能够正确设置，但附带的消息内容却无法生效。

问题现象

在常规使用场景中，开发者通常会通过以下命令生成变更日志并准备发布：

git cliff --bump --with-tag-message "发布说明"

这种方式能够正常工作，变更日志中会包含指定的发布说明信息。然而，当开发者尝试使用更精确的版本控制方式时：

git cliff --tag 1.0.0 --with-tag-message "发布说明"

虽然版本号 1.0.0 被正确应用，但"发布说明"信息却丢失了，导致生成的变更日志中消息部分为空。

技术背景

Git-Cliff 是一个用于生成美观变更日志的工具，它能够从 Git 提交历史中提取信息并格式化输出。在发布流程中，--tag 参数用于指定未发布变更的目标版本号，而 --with-tag-message 则允许开发者为此版本添加自定义描述信息。

问题根源

经过分析，这个问题源于参数处理逻辑中的一个缺陷。当使用 --tag 参数显式指定版本号时，系统未能正确地将 --with-tag-message 参数的值传递到内部处理流程中，导致消息内容被丢弃。

典型工作流影响

这个问题影响了典型的发布工作流。许多团队采用类似以下的自动化发布脚本：

VERSION=$(git cliff --bumped-version)
MESSAGE="重要修复说明"
git cliff --output --tag "$VERSION" --with-tag-message "$MESSAGE"
git add .
git commit -F- <<EOF
v$VERSION

$MESSAGE
EOF
git tag $VERSION -m "$MESSAGE"

在这种情况下，由于消息传递失效，生成的变更日志会缺少重要的发布说明信息，降低了变更日志的可读性和实用性。

解决方案

该问题已在项目的最新修复中得到解决。修复确保了无论通过 --bump 自动生成版本号，还是通过 --tag 手动指定版本号，--with-tag-message 参数都能正常工作，将指定的消息内容正确包含在生成的变更日志中。

最佳实践建议

对于使用 Git-Cliff 的团队，建议：

1. 确保使用包含此修复的最新版本
2. 在发布流程中始终验证生成的变更日志是否包含预期的消息内容
3. 考虑在自动化脚本中添加验证步骤，确保关键信息不会丢失

这个问题提醒我们，在使用工具链时，即使是看似简单的参数组合，也可能存在意料之外的行为，定期验证工作流的每个环节是十分必要的。