Commitizen工具中如何自定义Changelog包含提交哈希值

在软件开发过程中，生成清晰明了的变更日志(Changelog)对于项目维护至关重要。Commitizen作为一个流行的Git提交信息规范化工具，提供了强大的Changelog生成功能。本文将深入探讨如何在Commitizen生成的Changelog中自定义包含提交的SHA1哈希值。

为什么需要显示提交哈希

在Changelog中显示每个变更对应的提交哈希值有几个显著优势：

1. 可追溯性：开发者可以快速定位到具体的代码变更
2. 调试辅助：当发现问题时，能迅速找到引入变更的提交
3. 审计需求：满足某些项目的合规性要求
4. 协作效率：团队成员可以更高效地讨论特定变更

Commitizen的Changelog生成机制

Commitizen使用Jinja2模板引擎来生成Changelog，默认模板会显示变更类型(如feat、fix等)、作用域(scope)和变更消息。但默认情况下不包含提交的哈希值。

实现自定义Changelog包含哈希值

Commitizen提供了灵活的扩展机制，可以通过changelog_message_builder_hook钩子函数来自定义Changelog内容。以下是实现步骤：

1. 创建自定义配置：在项目根目录的pyproject.toml或.cz.yaml中配置自定义钩子

2. 实现钩子函数：编写Python函数来扩展变更信息

def changelog_message_builder_hook(self, parsed_message: dict, commit: git.GitCommit) -> dict:
    parsed_message.update(
        sha1=commit.rev,  # 添加提交哈希
        author=commit.author,  # 添加作者信息
        author_email=commit.author_email  # 添加作者邮箱
    )
    return parsed_message

3. 自定义模板：修改Changelog模板以显示新增的信息

{% for change in changes %}
{% if change.scope %}
- *{{ change.scope }}*: {{ change.message }} ({{ change.sha1 }} by {{ change.author }})
{% elif change.message %}
- {{ change.message }} ({{ change.sha1 }} by {{ change.author }})
{% endif %}
{% endfor %}

性能考量

需要注意的是，在Changelog中包含提交哈希和作者信息会增加内存使用量，特别是对于大型项目或历史悠久的仓库。建议：

• 仅在确实需要时添加这些信息
• 考虑只显示短哈希(前7位)以减少输出长度
• 对于大型项目，可以分批生成Changelog

高级定制

除了基本的哈希和作者信息，还可以通过这个机制添加更多元数据：

• 提交日期
• 关联的问题跟踪编号
• 变更影响的文件列表
• 代码审查状态

Commitizen的这种灵活设计使得团队可以根据项目需求定制最适合的Changelog格式，平衡信息的丰富性和可读性。