如何在Gerrit 2.16中配置服务器端钩子以验证Git提交消息

我来帮你梳理下Gerrit 2.16服务器端提交消息验证的可行方案，刚好我之前也折腾过类似的配置：

一、找到服务器端的commit-msg脚本路径 #

你本地通过scp下载的commit-msg脚本，源头就在Gerrit服务器的全局钩子目录里：

• 默认路径是$GERRIT_SITE/hooks，其中$GERRIT_SITE是你的Gerrit站点根目录（比如常见的/var/gerrit或者你安装时指定的路径）
• 这个目录下的commit-msg就是用户克隆项目时能下载到本地的模板脚本，你可以直接修改它，之后新克隆项目的用户会自动获取修改后的版本；已克隆的用户需要重新执行scp命令更新本地钩子。

不过要注意：修改这个脚本只能约束本地提交，用户如果绕过本地钩子（比如手动修改提交消息），还是能推送到Gerrit，所以服务器端强制验证需要用专门的服务器钩子。

二、服务器端强制验证的正确配置方法 #

你之前复制ref-update、patchset-created等脚本没生效，大概率是权限或Gerrit配置没到位，下面是完整的配置步骤：

1. 准备服务器端钩子脚本 #

Gerrit支持多种服务器端钩子，推荐用commit-received（在提交被接收时触发）或patchset-created（在补丁集创建时触发）来做提交消息验证：

• 在$GERRIT_SITE/hooks目录下创建或编辑对应的钩子脚本，比如commit-received
• 写入你的验证逻辑，比如检查提交消息是否包含指定格式的Change-Id、是否符合团队规范等，示例代码片段：

  #!/bin/bash
  commit_msg=$(git log --format=%B -n 1 $COMMIT)
  # 检查是否包含Change-Id
  if ! echo "$commit_msg" | grep -q "Change-Id: I[0-9a-f]\{40\}"; then
      echo "ERROR: 提交消息必须包含有效的Change-Id!" >&2
      exit 1
  fi
  # 其他验证规则...
  exit 0
  

2. 设置正确的权限 #

钩子脚本必须满足权限要求才能被Gerrit执行：

# 给脚本添加执行权限
chmod +x $GERRIT_SITE/hooks/commit-received
# 修改脚本所属用户为Gerrit运行用户（通常是gerrit）
chown gerrit:gerrit $GERRIT_SITE/hooks/commit-received

3. 配置Gerrit启用钩子 #

确保Gerrit的全局配置文件$GERRIT_SITE/etc/gerrit.config里开启了钩子支持：

[hooks]
  enabled = true
  # 如果要让新建项目自动继承全局钩子，添加下面的配置
  defaultClone = true

配置完成后重启Gerrit服务：

service gerrit restart

4. 同步钩子到已有项目 #

对于已经创建的项目，需要手动把钩子脚本复制到项目的Git仓库目录：

cp $GERRIT_SITE/hooks/commit-received $GERRIT_SITE/git/<你的项目名>.git/hooks/
# 同样设置权限
chmod +x $GERRIT_SITE/git/<你的项目名>.git/hooks/commit-received
chown gerrit:gerrit $GERRIT_SITE/git/<你的项目名>.git/hooks/commit-received

三、替代方案：用Gerrit内置的提交消息验证 #

如果你的验证规则比较简单（比如强制Change-Id、限制消息长度），可以不用写钩子，直接在项目的project.config里配置：

1. 通过Gerrit UI进入项目的「Settings」→「General」
2. 编辑project.config，添加以下配置：

   [commitMessageValidation]
     # 强制要求包含Change-Id
     requiredFooter = Change-Id: I[0-9a-f]{40}
     # 限制提交消息最大长度
     maxLength = 1000
     # 可选：要求消息首行符合格式
     requiredSubjectPattern = ^\[BUGFIX\]|\[FEATURE\]|\[REFACTOR\]: .+$
   

3. 保存配置后，Gerrit会自动验证所有新提交的消息格式。

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