Git 钩子可以自动将文件添加到提交中吗？

Question

我想使用 Git 中的 pre-commit 或 post-commit 挂钩将自动生成的文件添加到同一个提交中，具体取决于在该提交中修改的文件。我该怎么办？

我已尝试将此作为预提交挂钩，但没有运气：

#!/bin/sh
files=`git diff --cached --name-status`
re="<files of importance>"
if [[ $files =~ $re ]]
then
  echo "Creating files"
  exec bundle exec create_my_files
  exec git add my_files
  exec git commit --amend -C HEAD
fi

这成功地将它们添加到存储库中，但不会将它们添加到提交中。我还尝试在提交后挂钩中使用最后两个 exec 行以及提交前检查，但也没有好处。

Answer 1

你可以使用update-index:

git update-index --add my_files

Answer 2

如果文件是自动生成的，并且它们可以在任何地方生成（暗示您希望在 Git 预提交挂钩中构建它们），那么您首先不应该将它们置于源代码控制之下。您应该只控制源文件——生成的文件应该作为构建脚本的一部分生成。

将生成的文件置于源代码控制之下的唯一原因是它需要独特/特权资源来生成（例如许可程序）或需要大量时间来生成。

已添加

来自http://git-scm.com/docs/githooks：

pre-commit 这个钩子由 git 调用 提交，并且可以绕过 --no-verify 选项。它不带参数，并且在之前被调用 获取建议的提交日志 消息并提交。退出 此脚本中的非零状态 导致 git 提交中止。

默认的预提交钩子，当 启用，捕获行的介绍 带有尾随空格和中止 找到这样一行时的提交。

所有的 git commit 钩子都被调用 与环境变量 GIT_EDITOR=: 如果命令不会 调出编辑器来修改 提交消息。

预提交挂钩的目的是在提交之前对工作区的状态和提交的内容进行通过失败检查。尝试更改提交内容是行不通的。

我的建议是在您的构建脚本中添加两个步骤：(1) 一个步骤将构建所有需要生成的过时文件（并将它们添加到工作区），以及 (2)一个步骤，将检查以确保所有生成的文件都是最新的，并返回非零状态代码。你的 Git 预提交钩子应该运行第二步。您的开发人员应接受培训，以便在必要时运行第一步。

Answer 3

不如编写一个post-commit 脚本来生成您的文件，然后让 执行（类似于）git add my_files; git commit --amend。

Answer 4

使用预提交钩子可以做你想做的事。我们为heroku 部署做了类似的事情（将coffeescript 编译成javascript）。你的脚本不工作的原因是你不正确地使用了exec 命令。

来自man page：

exec 内置命令用于用新命令替换当前运行的 shell 进程映像。成功完成后， exec 永远不会返回。 exec 不能在管道内使用。

只有您的第一个 exec 命令正在运行。之后，您的脚本基本上就被终止了。

试试这样的东西（作为预提交挂钩）：

#!/bin/sh
files=`git diff --cached --name-status`
re="<files of importance>"
if [[ $files =~ $re ]]
then
  echo "Creating files"
  bundle exec create_my_files
  git add my_files
fi

Answer 5

我也有同样的需求，这种方法对我来说效果很好：

#!/bin/sh
files='git diff --cached --name-only'
re="<files of importance>"
if [[ $files =~ $re ]]
then
   echo "Creating files"
   create_my_files && git add my_files
fi

其中“create_my_files”应该是可执行的，例如，如果它是一个 python 文件，您可以将其执行为“python create_my_files && git add my_files”

确实，您不需要预先提交即可再次提交（这将创建一个无限的讨厌循环：p）

Answer 6

您可以结合使用前提交和后提交脚本。

在预提交中：

• 触摸一个文件 .commit 什么的。 （请务必将此添加到 .gitignore）

在提交后：

如果 .commit 存在，您就知道提交刚刚发生，但后提交尚未运行。因此，您可以在这里进行代码生成。此外，测试 .commit 是否存在：

• 添加文件
• commit --amend -C HEAD --no-verify（避免循环）
• 删除 .commit 文件

这大致是我用来在从 Metastore 生成的存储库中存储 .metadata 文件的过程。

如果有人知道更好的方法，我会全力以赴，但它现在似乎有效。

Answer 7

由于 git add 在预提交中也不适合我，我遵循了马克的想法，使用 .commit 文件并将过程分为提交前和提交后。

这里有一些代码应该很容易理解

在预提交中：

• 触摸一个文件 .commit 什么的。 （请务必将此添加到 .gitignore）

#!/bin/sh 
echo 
touch .commit 
exit

在提交后：

如果 .commit 存在，您知道提交刚刚发生，但是 提交后尚未运行。因此，您可以在这里进行代码生成。 此外，测试 .commit 是否存在：

• 添加文件
• commit --amend -C HEAD --no-verify（避免循环）
• 删除 .commit 文件

#!/bin/sh
echo
if [ -e .commit ]
    then
    rm .commit
    git add yourfile
    git commit --amend -C HEAD --no-verify
fi
exit

希望这能让没有 bash 知识的人更容易理解 mark 的想法。

Answer 8

#!/bin/sh
#
#  .git/hooks/pre-commit
#

git add file.xyz

这对我来说效果很好。 它将成为当前提交的一部分。

git version 1.7.12.4 (Apple Git-37)

Answer 9

是的，您可以使用 git hooks 在提交时自动添加生成的文件！但它需要一个棘手的脚本。

在这里您可以找到已解决的问题。在那里，它会在每次提交时更新文件版本，添加新的修改文件并根据需要修改提交。它完全正常工作： https://github.com/evandrocoan/.versioning

然后，您只需用您的算法替换文件“updateVersion.sh”上的“版本文件替换”算法。也许您需要更改一些内容，例如删除分支限制，因为那里的脚本只有在您位于“开发”分支时才会运行。

此外，它只会更改指定的文件，如果已暂存。如果文件没有暂存，那么它只会做正常/通常的提交。更准确地说，它会打印出每一步都在做什么。

我将解释这个技巧。这很棘手。在 prepare-commit-msg-hook 上，它检测是否正在暂存和提交所需的文件。之后，它会创建一个标志文件，并停止 prepare-commit-msg-hook。 稍后在 post-commit-hook 上，它检查标志文件是否存在。如果是，它会修改提交时的文件。

注意，它会创建一个无限循环，因为它会再次调用 prepare-commit-msg-hook（正如我们正在修改的那样）。但它不会因为标志文件而发生。当 prepare-commit-msg-hook 运行并找到标志文件时，它“知道”发生了什么。然后只是删除标志文件并且不再创建它。这样做，它将阻止 post-commit-hook 再次修改提交，从而使提交永远完成。

Answer 10

我在预提交挂钩中也面临同样的问题。我正在修改一个文件并提交，但它正在使用以前的文件而不是更新的文件，因此通过在 pre-commit 挂钩中添加 git 命令（如下所示），它解决了。

git add $file

注意：$file 是您要添加的文件。

谢谢，