将git钩子放入存储库

将.git / hooks放入项目存储库（例如，使用符号链接）是否被认为是不好的做法？如果是，向不同的git用户传递相同的钩子的最佳方法是什么？

我通常同意Scytale，并提供一些其他建议，足以值得单独回答。

首先，您应该编写一个脚本来创建适当的符号链接，尤其是在这些挂钩与执行策略或创建有用的通知有关的情况下。如果人们能够打字bin/create-hook-symlinks，他们将比使用自己必须的钩子更有可能使用钩子。

其次，直接符号链接挂钩可防止用户添加自己的个人挂钩。例如，我更喜欢示例预提交钩子，该钩子确保我没有任何空格错误。解决此问题的一种好方法是在存储库中放入一个挂钩包装脚本，并将所有挂钩符号链接到它。然后，包装器可以检查$0（假设它是一个bash脚本；一个等效的argv[0]其他方法）来确定调用它的钩子，然后在您的仓库中调用适当的钩子，以及适当的用户钩子，将其重命名。 ，将所有参数传递给每个参数。内存中的快速示例：

#!/bin/bash
if [ -x $0.local ]; then
    $0.local "$@" || exit $?
fi
if [ -x tracked_hooks/$(basename $0) ]; then
    tracked_hooks/$(basename $0) "$@" || exit $?
fi

安装脚本会将所有先前存在的钩子移到侧面（追加.local到它们的名称），并将所有已知的钩子名称符号链接到上述脚本：

#!/bin/bash
HOOK_NAMES="applypatch-msg pre-applypatch post-applypatch pre-commit prepare-commit-msg commit-msg post-commit pre-rebase post-checkout post-merge pre-receive update post-receive post-update pre-auto-gc"
# assuming the script is in a bin directory, one level into the repo
HOOK_DIR=$(git rev-parse --show-toplevel)/.git/hooks

for hook in $HOOK_NAMES; do
    # If the hook already exists, is executable, and is not a symlink
    if [ ! -h $HOOK_DIR/$hook -a -x $HOOK_DIR/$hook ]; then
        mv $HOOK_DIR/$hook $HOOK_DIR/$hook.local
    fi
    # create the symlink, overwriting the file if it exists
    # probably the only way this would happen is if you're using an old version of git
    # -- back when the sample hooks were not executable, instead of being named ____.sample
    ln -s -f ../../bin/hooks-wrapper $HOOK_DIR/$hook
done

不，将它们放入存储库中很好，我什至建议这样做（如果它们对其他人也有用）。用户必须显式地启用它们（如您所说的，例如通过符号链接），这一方面让人感到有些痛苦，但另一方面却可以保护用户免于未经他们的同意运行任意代码。

现在，你可以做以下设置的一个目录版本控制下的混帐挂钩目录，例如，MY_REPO_DIR/.githooks将

git config --local core.hooksPath .githooks/

仍然不能直接执行，但是，如果在自述文件（或其他内容）中添加注释，则每个开发人员都需要付出最少的精力。

在http://git-scm.com/docs/git-init#_template_directory中，您可以使用以下一种机制来更新每个新创建的git repo的.git / hooks目录：

模板目录包含创建后将复制到$ GIT_DIR的文件和目录。

模板目录将是以下（按顺序）之一：

• --template选项给出的参数；

• $ GIT_TEMPLATE_DIR环境变量的内容；

• init.templateDir配置变量；要么

• 默认模板目录：/ usr / share / git-core / templates。

存储在项目中并在构建中安装

正如其他人在回答中所说的那样，如果您的钩子是特定于您的特定项目的，则将它们包括在项目本身中，由git管理。我会更进一步说，鉴于优良作法是使用单个脚本或命令来构建项目，因此应在构建过程中安装挂钩。

我写了一篇有关管理git hook的文章，如果您有兴趣深入了解这一点。

Java和Maven

完整的免责声明；我写了下面描述的Maven插件。

如果您正在使用Java项目的Maven处理构建管理，则以下Maven插件可以处理从项目中某个位置的安装挂钩。

https://github.com/rudikershaw/git-build-hook

将所有Git钩子放置在项目的目录中，然后将其配置pom.xml为包括以下插件声明，目标和配置。

<build>
  <plugins>
    <plugin>
      <groupId>com.rudikershaw.gitbuildhook</groupId>
      <artifactId>git-build-hook-maven-plugin</artifactId>
      <configuration>
        <gitConfig>
          <!-- The location of the directory you are using to store the Git hooks in your project. -->
          <core.hooksPath>hooks-directory/</core.hooksPath>
        </gitConfig>
      </configuration>
      <executions>
        <execution>
          <goals>       
            <!-- Sets git config specified under configuration > gitConfig. -->
            <goal>configure</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
      <!-- ... etc ... -->
  </plugins>
</build>

当您运行项目构建时，插件将配置git以在指定目录之外运行钩子。这将为项目中的每个人有效地在该目录中设置钩子。

JavaScript和NPM

对于NPM，有一个名为Husky的依赖项，可让您安装包含用JavaScript编写的钩子的钩子。

// package.json
{
  "husky": {
    "hooks": {
      "pre-commit": "npm test",
      "pre-push": "npm test",
      "...": "..."
    }
  }
}

其他

此外，还有针对Python项目的预提交，针对Ruby项目的过量提交和针对Ruby 或 Node项目的Lefthook。

该https://www.npmjs.com/package/pre-commit NPM包处理此典雅允许你指定预先承诺钩子钩住你的package.json。

对于基于Composer的PHP项目，您可以自动将其分发给工程师。这是pre-commit和commit-msg挂钩的示例。

创建一个hooks文件夹，然后在composer.json中：

 },
 "scripts": {
     "post-install-cmd": [
         "cp -r 'hooks/' '.git/hooks/'",
         "php -r \"copy('hooks/pre-commit', '.git/hooks/pre-commit');\"",
         "php -r \"copy('hooks/commit-msg', '.git/hooks/commit-msg');\"",
         "php -r \"chmod('.git/hooks/pre-commit', 0777);\"",
         "php -r \"chmod('.git/hooks/commit-msg', 0777);\"",
     ],

然后您甚至可以在每个人composer install定期运行的项目继续进行时更新它们。

这是一个脚本add-git-hook.sh，您可以将其作为常规文件发送到存储库中，并可以执行以将git hook附加到脚本文件中。调整要使用的钩子（提交前，提交后，推送前等），以及cat heredoc中钩子的定义。

#!/usr/bin/bash
# Adds the git-hook described below. Appends to the hook file
# if it already exists or creates the file if it does not.
# Note: CWD must be inside target repository

HOOK_DIR=$(git rev-parse --show-toplevel)/.git/hooks
HOOK_FILE="$HOOK_DIR"/post-commit

# Create script file if doesn't exist
if [ ! -e "$HOOK_FILE" ] ; then
        echo '#!/usr/bin/bash' >> "$HOOK_FILE"
        chmod 700 "$HOOK_FILE"
fi

# Append hook code into script
cat >> "$HOOK_FILE" <<EOF

########################################
# ... post-commit hook script here ... #
########################################

EOF

拥有可执行权限可能有意义，或者用户可以直接运行它。提交后，我使用它在其他计算机上自动进行git-pull。

编辑-我回答了一个更简单的问题，它不是问什么，也不是OP想要的东西。我选择了在仓库中运送钩子脚本的用例和参数，而不是在下面的评论中从外部进行管理。希望这就是您想要的。

您可以将托管解决方案用于pre-commit挂钩管理，例如pre-commit。或针对服务器端git-hooks的集中式解决方案，例如Datree.io。它具有内置策略，例如：

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

它不会取代您所有的钩子，但可以帮助最明显的钩子开发人员，而无需在每台开发者计算机/存储库上安装钩子的配置。

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