Git 挂钩脚本可以与存储库一起管理吗？

Question

我们想要制作一些我们都可以共享的基本钩子脚本——用于预格式化提交消息之类的事情。 Git 有钩子脚本，通常存储在 /.git/hooks/ 下。 但是，当人们进行克隆时，这些脚本不会传播，并且它们不受版本控制。

有没有一个好的方法可以帮助大家获得正确的hook脚本呢？ 我可以让这些钩子脚本指向我的存储库中的版本控制脚本吗？

Answer 1

在 Git 2.9 中，
配置选项 core.hooksPath< /a> 指定自定义挂钩目录。

将您的钩子移至存储库中的 hooks 跟踪目录。 然后，配置存储库的每个实例以使用跟踪的hooks而不是$GIT_DIR/hooks：

git config core.hooksPath hooks

通常，路径可以是绝对路径，或相对于运行钩子的目录（通常是工作树根；请参阅 man 的描述部分githooks）。

Answer 2

理论上，您可以在项目目录中创建一个包含所有脚本的 hooks 目录（或您喜欢的任何名称），然后在 .git/hooks 中对它们进行符号链接。 当然，每个克隆存储库的人都必须设置这些符号链接（尽管您可能会非常喜欢并拥有一个克隆程序可以运行以半自动设置它们的部署脚本）。

要在 *nix 上进行符号链接，您需要做的就是：

root="$(pwd)"
ln -s "$root/hooks" "$root/.git/hooks"

如果您准备好覆盖 .git/hooks 中的内容，请使用 ln -sf

Answer 3

对于 Node.js 用户，一个简单的解决方案是更新 package.json 和

{
  "name": "name",
  "version": "0.0.1",
  ......
  "scripts": {
    "preinstall": "git config core.hooksPath hooks",

预安装 将在之前运行

npm 安装

并重定向 Git 以在 .\hooks （或您选择的任何名称）目录中查找挂钩。 该目录应在文件名（减去 .sample）和结构方面模仿 .\.git\hooks。

想象一下 Maven 和其他构建工具将具有相当于预安装的功能。

它还应该适用于所有平台。

如果您需要更多信息，请参阅与团队共享 Git hook 的两种方法。

Answer 4

我想将几个答案合并为一个。 假设您位于 project/ 目录中：

设置自定义挂钩

1. 创建 .githooks 目录并将挂钩放入其中。 （有关示例，请参阅 .git/hooks）

2. 创建指向目录 1：

   git config -f .gitconfig core.hooksPath .githooks 
     

3. 在 Makefile 中创建以下规则：²

   启用 git-hooks： 
         git config --local include.path ../.gitconfig 
         $（警告记住，您必须查看自定义挂钩！） 
     

启用自定义挂钩

每个开发人员都应该查看这些自定义挂钩后明确启用它们。 在自述文件中添加一条指令，如下所示：

通过 make enable-git-hooks 查看自定义挂钩后启用它们。

Answer 5

如果您的项目是 JavaScript 项目并且使用 npm 作为包管理器，则可以使用 shared-git-hooks 在 npm install 上强制执行 Git 挂钩。

完全披露：我写了这个包

Answer 6

大多数现代编程语言，或者更确切地说是它们的构建工具，都支持插件来管理 Git 挂钩。 这意味着您需要做的就是配置 package.json、pom.xml 等文件，团队中的任何人都别无选择，只能遵守，除非他们更改构建文件。

该插件将为您添加内容到 .git 目录。

示例：

Git Build Hook Maven 插件< /em>

githook-maven-plugin

git-hooks-js

Answer 7

使用 git-hooks。 它将 .git/hooks 调用路由到项目目录 githooks 下的脚本中。

还有很多功能可以让您最大限度地减少各处的复制和符号链接挂钩。

Answer 8

我们正在使用具有构建前和构建后事件的 Visual Studio 解决方案（以及项目）。 我正在添加一个名为“GitHookDeployer”的附加项目。 项目在构建后事件中自行修改文件。 该文件设置为复制到构建目录。 因此，该项目每次都会构建并且永远不会被跳过。 在构建事件中，它还确保所有 git hook 都就位。

请注意，这不是一个通用的解决方案，因为有些项目当然不需要构建任何东西。

Answer 9

您可以使用托管解决方案进行预提交挂钩管理，例如 预提交。
或者是服务器端 git-hooks 的集中式解决方案，例如 Datree.io。
它具有内置策略，例如：

1. 检测并防止秘密合并。
2. 强制实施正确的 Git 用户配置。
3. 强制执行 Jira 票证集成 - 提及票证号在拉取请求名称/提交消息中。

它不会取代您的所有钩子，但它可能会帮助您的开发人员使用最明显的钩子，而无需在每个钩子上安装钩子的配置地狱。
开发人员计算机/仓库。

免责声明：我是 Datrees 创始人之一

Answer 10

理想情况下，如果您遵循示例文件，则挂钩是用 Bash 编写的。 但您可以用任何可用的语言编写它，只需确保它具有可执行标志即可。

因此，您可以编写Python或Go代码来实现您的目标，并将其放在hooks文件夹下。 它可以工作，但不会与存储库一起管理。

两个选项

a) 多脚本

您可以在帮助中编写挂钩，并在挂钩中添加一小段代码，以调用您的完美脚本，如下所示：

$ cat .git/hooks/pre-commit
#!/bin/bash
../../hooks/myprecommit.js

b) 单个脚本

一种更酷的选择是仅添加一个脚本来规则所有这些，而不是多个脚本。 因此，您创建一个 hooks/mysuperhook.go 文件并将您想要的每个钩子指向它。

$ cat .git/hooks/pre-commit
#!/bin/bash
../../hooks/mysuperhook.go $(basename $0)

该参数将向您的脚本提供触发了哪个钩子，您可以在代码中区分它。 为什么？ 例如，有时您可能希望对提交和推送运行相同的检查。

然后？

然后，您可能需要更多功能，例如：

• 手动触发挂钩以检查一切是否正常，甚至在提交或推送之前也是如此。 如果你只是调用你的脚本（选项a或b）就可以了。
• 触发 CI 上的挂钩，因此您无需为 CI 重写相同的检查。 例如，它只是调用提交和推送触发器。 和上面的方法一样应该可以解决。
• 调用外部工具，例如 Markdown 验证器或 YAML 验证器。 您可以进行系统调用并需要处理标准输出和标准错误。
• 确保所有开发人员都有一个简单的方法来安装钩子，因此需要将一个好的脚本添加到存储库中，以用正确的钩子替换默认钩子
• 有一些全局帮助程序，例如检查阻止对开发和主分支的提交，而不是必须将其添加到每个存储库中。 您可以通过使用另一个带有全局脚本的存储库来解决这个问题。

这可以更简单吗？

是的，有多种工具可以帮助您管理 Git 挂钩。 它们中的每一个都是为了从不同的角度解决问题而量身定制的，您可能需要了解所有这些，才能找到最适合您或您的团队的一个。 GitHooks.com 提供了大量有关挂钩的阅读材料，以及当今可用的多种工具。

截至今天，那里列出了 21 个项目，它们采用不同的策略来管理 Git 挂钩。 有些仅针对单个钩子，有些针对特定语言，等等。

其中一个工具是我编写的，作为开源项目免费提供，名为 hooks4git 。 它是用 Python 编写的（因为我喜欢它），但其想法是在一个名为 .hooks4git.ini 的配置文件中处理上面列出的所有项目，该文件位于您的存储库中并可以调用任何脚本您想用任何语言打电话。

使用 Git hooks 绝对是非常棒的，但它们提供的方式通常只会让人们远离它。

Answer 11

对于 Gradle 用户，

我发现这些脚本对于 Gradle 项目非常有用。

build.gradle

apply from: rootProject.file('gradle/install-git-hooks.gradle')

gradle/install-git-hooks.gradle

tasks.create(name: 'gitExecutableHooks') {
    doLast {
        Runtime.getRuntime().exec("chmod -R +x .git/hooks/");
    }
}
task installGitHooks(type: Copy) {
    from new File(rootProject.rootDir, 'pre-commit')
    into { new File(rootProject.rootDir, '.git/hooks') }
}
gitExecutableHooks.dependsOn installGitHooks
clean.dependsOn gitExecutableHooks

预提交

.... your pre commit scripts goes here

Answer 12

受到 a3765910 的 Gradle answer 的启发，但经过修改以运行每个构建。

将以下内容添加到应用程序的 build.gradle 中（假设您已经创建了要保留在源代码管理中的 githooks/pre-commit 文件）：

copy {
    from new File(rootProject.rootDir, 'githooks/pre-commit')
    into { new File(rootProject.rootDir, '.git/hooks') }
}

Answer 13

您可以将您的 hooks 文件夹创建为另一个 Git 存储库，并将其作为子模块链接...

我想只有当您有很多成员并且定期更改挂钩时才值得这样做。

Answer 14

我目前正在我们的代码库中处理此问题，并且遇到了一个名为 husky 的库，它简化了如何在团队中使用和共享 GitHub Hooks。 我强烈建议对此进行调查。

Answer 15

要版本化您的 hooks 目录（假设它存储在 hooks/ 中），请在工作副本根目录中创建一个 .gitconfig 文件，其中包含以下内容：

[core]
hooksPath = hooks

它将覆盖 。 git/config.