将.git/hooks放入项目存储库(例如,使用符号链接)被认为是一种糟糕的做法吗?如果是,将相同的钩子传递给不同的Git用户的最佳方式是什么?
当前回答
从TEMPLATE DIRECTORY,你可以使用这些机制之一来更新每个新创建的Git存储库的.git/hooks目录:
模板目录包含将被删除的文件和目录 在创建后复制到$GIT_DIR。 模板目录将是以下目录之一(按顺序): ——template选项给出的参数; $GIT_TEMPLATE_DIR环境变量的内容; init。templateDir配置变量;或 模板默认目录:/usr/share/git-core/templates
其他回答
预提交npm包很好地处理了这个问题,允许你在包中指定预提交钩子。json文件。
从TEMPLATE DIRECTORY,你可以使用这些机制之一来更新每个新创建的Git存储库的.git/hooks目录:
模板目录包含将被删除的文件和目录 在创建后复制到$GIT_DIR。 模板目录将是以下目录之一(按顺序): ——template选项给出的参数; $GIT_TEMPLATE_DIR环境变量的内容; init。templateDir配置变量;或 模板默认目录:/usr/share/git-core/templates
这里有一个脚本add-git-hook.sh,您可以在存储库中作为常规文件发布它,并可以执行它来将Git钩子附加到脚本文件中。调整使用哪个钩子(pre-commit, post-commit, pre-push,等等),并在cat中定义钩子。
#!/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想要的。在下面的评论中,我对在存储库中交付钩子脚本与在外部管理它们的用例和参数发表了看法。
我基本上同意Scy的观点,还有一些额外的建议,足以让它值得一个单独的答案。
首先,您应该编写一个脚本来创建适当的符号链接,特别是当这些钩子是关于执行策略或创建有用的通知时。如果人们只需要输入bin/create-hook-symlinks,而不是自己动手,他们就更有可能使用这些hook。
其次,直接符号链接钩子可以防止用户添加自己的个人钩子。例如,我非常喜欢预提交钩子样本,它可以确保我没有任何空白错误。解决这个问题的一个好方法是在存储库中放入钩子包装器脚本,并将所有钩子符号链接到它。
然后包装器可以检查$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
存储在项目中并安装在构建中
正如其他人在他们的答案中所述,如果你的钩子是特定于你的特定项目的,那么就将它们包含在项目本身中,由Git管理。我想进一步说,考虑到使用单个脚本或命令构建项目是一种良好的实践,您的钩子应该在构建期间安装。
我写过一篇关于管理Git钩子的文章,如果您有兴趣深入阅读的话。
Java和Maven
完整的免责声明;我编写了下面描述的Maven插件。
如果您正在使用Maven为您的Java项目处理构建管理,那么下面的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项目的Overcommit和用于Ruby或Node.js项目的Lefthook。
推荐文章
- 如何将git配置存储为存储库的一部分?
- 如何修改GitHub拉请求?
- 如何在Github和本地删除最后n次提交?
- 我如何调试git/git-shell相关的问题?
- 错误:无法使用rebase进行拉取:您有未分阶段的更改
- Git隐藏未缓存:如何把所有未分期的变化?
- 真实的恶魔
- 如何从另一个分支获得更改
- Git:权限被拒绝(publickey)致命-无法从远程存储库读取。克隆Git存储库时
- git reflog和log有什么区别?
- git推挂在Total line之后
- 重命名git子模块
- 结合Git存储库的前两次提交?
- Xcode 6 gitignore文件应该包括什么?
- 我如何从现有回购的分支创建一个新的GitHub回购?