Git Hooks技术实现：如何强制提交时包含指定文件变更？

要实现你需求的提交校验，用Git的pre-commit钩子就能搞定——这是Git自带的提交前校验机制，完全不需要额外工具。

核心逻辑 #

你的伪代码逻辑可以直接转成可执行的脚本：

• 检查当前分支是否为master
• 如果是master分支，再检查本次提交里是否包含CHANGELOG.md的变更
• 两个条件同时满足（master分支且CHANGELOG没改）时，拒绝提交；其他情况允许提交

具体实现步骤 #

1. 在项目的.git/hooks目录下创建pre-commit文件（注意没有后缀名）
2. 将以下脚本内容复制进去：

#!/bin/bash

# 获取当前分支名称
current_branch=$(git rev-parse --abbrev-ref HEAD)

# 检查是否是master分支
if [ "$current_branch" = "master" ]; then
    # 检查CHANGELOG.md是否在本次提交的变更文件列表中
    if ! git diff --cached --name-only | grep -q "^CHANGELOG.md$"; then
        echo "❌ 向master分支提交必须更新CHANGELOG.md文件，请添加该文件的修改后再提交"
        exit 1
    fi
fi

# 校验通过，允许提交
exit 0

3. 给脚本添加执行权限：

chmod +x .git/hooks/pre-commit

脚本说明 #

• git rev-parse --abbrev-ref HEAD：获取当前所在的分支名称
• git diff --cached --name-only：列出本次提交暂存区里的所有变更文件
• grep -q "^CHANGELOG.md$"：检查列表里是否包含CHANGELOG.md，-q表示静默匹配，只返回结果状态
• 如果校验不通过，脚本返回exit 1，Git会终止提交流程；返回exit 0则允许提交

这样设置后，只要有人向master分支提交代码但没更新CHANGELOG.md，Git就会直接拒绝提交，强制所有人遵守更新日志的规则。

内容的提问来源于stack exchange，提问作者Jonas Borggren