描述

Git钩子，用于准备提交消息。

将检查您是否允许提交，如果允许提交，将检查是否存在与分支匹配的引用；如果没有，将更新提交消息。

使用方法

构建项目

cargo install git-hook-commit-ref

将钩子安装到当前的git仓库

cd my_git_project
git hook-commit-ref --install

配置您的git仓库

在您的项目中，编辑 .git/config 文件，以添加组织名称、项目名称以及不允许提交的分支列表。

例如

[commit-ref-hook]
  org = "rednaks"
  project = "git-hook-commit-ref"
  forbiddenbranches = "master, release"
  branchpattern = "(?P<org>\w+).*-(?P<issue_number>\d+).*"

分支名称

默认分支名称应匹配 <org>-<issue_number> 模式，但如果您的分支名称不同，请确保添加匹配您分支名称的正则表达式。不要忘记添加 org 和 issue_number 以捕获匹配项。

org 是可选的，但 issue_number 是必需的。

检查一切是否正常

为了检查一切是否正常配置，您可以在您的git仓库中使用 git hook-commit-ref --check。

绕过钩子

在某些情况下，如合并或变基，没有当前分支，而是有一个引用。由于它不匹配钩子的配置，您将无法提交更改。在提交时，您可以使用 COMMIT_HOOK_IGNORE=true 环境变量来绕过钩子。