如何配置GitHub分支检查钩子，实现仓库级Git钩子自动同步

Git本身没有原生支持仓库级钩子的自动同步，但可以通过以下几种方案让开发者拉取仓库后自动获取钩子：

1. 仓库内钩子目录+配置引导 #

• 在仓库根目录创建git-hooks文件夹，存放你的钩子脚本（比如用于分支命名检查的pre-branch或pre-push脚本），确保脚本有执行权限：

  chmod +x git-hooks/pre-branch
  

• 在仓库根目录添加初始化脚本setup-hooks.sh，内容为设置Git钩子路径指向仓库内的git-hooks目录：

  #!/bin/bash
  git config core.hooksPath ./git-hooks
  

• 给初始化脚本加执行权限：chmod +x setup-hooks.sh
• 要求开发者克隆仓库后执行一次./setup-hooks.sh，后续拉取仓库更新时，钩子脚本会自动同步生效。

2. 结合Git模板目录实现克隆自动配置 #

• 在仓库内创建template/hooks目录，放入钩子脚本并添加执行权限。
• 编写脚本引导开发者在克隆后运行，将仓库的template目录设为当前仓库的模板目录：

  git config --local init.templateDir ./template
  

• 这种方式下，开发者后续在该仓库内创建子模块或重新初始化时，钩子会自动被复制到.git/hooks目录。

3. 借助pre-commit框架（可选） #

如果团队已使用pre-commit工具，可在仓库根目录添加.pre-commit-config.yaml配置文件，将分支命名检查作为钩子规则加入。开发者只需安装pre-commit并执行pre-commit install，后续拉取配置更新时，pre-commit会自动同步钩子规则。

分支命名检查钩子示例（pre-push脚本） #

以下是一个简单的pre-push脚本，用于检查推送的分支是否符合规范（必须以feature/、bugfix/、hotfix/等前缀开头）：

#!/bin/bash

BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)

# 定义允许的分支命名前缀
ALLOWED_PREFIXES="feature/ bugfix/ hotfix/ release/"

if [[ ! $BRANCH_NAME =~ ^($(echo $ALLOWED_PREFIXES | tr ' ' '|')) ]]; then
    echo "错误：分支命名不符合规范，必须以以下前缀开头：$ALLOWED_PREFIXES"
    exit 1
fi

exit 0

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