如何在GitLab中自动拒绝信息错误或不符合.clang-format规则的提交推送

1. 提交信息错误自动驳回 #

两种实现方式，可根据校验复杂度选择：

• 基础规则校验：直接使用GitLab内置推送规则
  进入项目后台 → 设置 → 仓库 → 推送规则，找到「提交信息正则表达式」配置项，填写符合你要求的提交信息匹配规则，不符合规则的推送会被系统自动驳回，无需额外开发。
• 复杂自定义校验：配置服务端pre-receive钩子
  如果需要实现类似必须关联工作项、多字段组合校验等复杂逻辑，可以编写自定义pre-receive钩子，核心校验逻辑示例如下：

  #!/bin/bash
  while read oldrev newrev refname; do
    # 遍历本次推送包含的所有提交
    for commit_id in $(git rev-list ${oldrev}..${newrev}); do
      commit_msg=$(git log --format=%B -n 1 ${commit_id})
      # 替换下方正则为你自己的校验规则，示例要求提交信息必须以feat/fix/docs等前缀开头
      if ! [[ ${commit_msg} =~ ^(feat|fix|docs|style|refactor|test|chore):\s. ]]; then
        echo "ERROR: 提交${commit_id}的信息不符合规范，必须以类型前缀开头，示例：feat: 新增用户登录功能"
        exit 1
      fi
    done
  done
  exit 0
  

2. Clang-Format格式不合规自动拦截 #

需要配合服务端pre-receive钩子实现，操作步骤如下：

• 首先确保GitLab服务器上已经安装clang-format工具，版本和你本地使用的版本保持一致，避免因版本差异导致校验结果不一致。
• 在pre-receive钩子中追加格式校验逻辑，示例代码如下：

  #!/bin/bash
  while read oldrev newrev refname; do
    # 创建临时目录解压提交的代码
    temp_workdir=$(mktemp -d)
    git archive ${newrev} | tar -x -C ${temp_workdir}
    # 遍历本次提交改动的C/C++/Object-C类文件
    for code_file in $(git diff --name-only ${oldrev} ${newrev} | grep -E "\.(c|cpp|cc|h|hpp|m|mm)$"); do
      target_file="${temp_workdir}/${code_file}"
      [ ! -f "${target_file}" ] && continue
      # 对比原文件和按.clang-format格式化后的内容差异
      clang-format --style=file ${target_file} | diff -u ${target_file} - > diff_result.log
      if [ $? -ne 0 ]; then
        echo "ERROR: 文件${code_file}不符合.clang-format格式规范，差异如下："
        cat diff_result.log
        rm -rf ${temp_workdir}
        exit 1
      fi
    done
    rm -rf ${temp_workdir}
  done
  exit 0
  

补充说明：

1. pre-receive钩子需要放置在GitLab服务端对应项目的仓库hooks目录下，或者管理员配置全局钩子应用到所有项目，钩子文件需要添加可执行权限，执行命令chmod +x pre-receive即可。
2. 也可以引导开发者本地配置pre-commit钩子，提交代码时就自动校验格式，提前发现问题减少推送失败的概率，服务端钩子作为强制拦截的最后一道防线，建议两端同时配置。

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