Git Hook中常用的钩子有哪些？

Git Hook 中常用的钩子

Git Hooks 是 Git 提供的一种机制，它允许用户在特定的事件发生时自动执行自定义脚本。这些钩子可以帮助开发者在代码提交、合并或推送等操作前后执行特定任务，从而提高开发效率和代码质量。以下是一些常用的 Git Hook 钩子及其功能。

1. `pre-commit`

pre-commit 钩子在执行 git commit 命令之前被触发。它通常用于执行代码检查、格式化和单元测试等操作。如果该钩子返回非零状态，提交将被中止。

示例用途：

代码格式化（如使用 Prettier 或 ESLint）
运行单元测试
检查代码规范

bash 复制代码

#!/bin/sh
# 运行 ESLint 检查
npm run lint
# 如果 ESLint 报错，终止提交
if [ $? -ne 0 ]; then
  echo "Linting failed. Commit aborted."
  exit 1
fi

2. `prepare-commit-msg`

prepare-commit-msg 钩子在编辑提交消息之前被调用。它可以用来修改默认的提交消息或自动生成提交消息。

示例用途：

自动添加 Jira 任务号到提交消息
根据提交类型生成标准化的提交消息

bash 复制代码

#!/bin/sh
# 在提交消息中添加时间戳
echo "$(date): " >> "$1"

3. `commit-msg`

commit-msg 钩子在提交消息被输入后、提交操作完成之前触发。它用于检查提交消息的格式。

示例用途：

确保提交消息遵循特定格式（如使用 Angular 规范）
验证提交消息长度

bash 复制代码

#!/bin/sh
# 检查提交消息的长度
MESSAGE="$(cat "$1")"
if [ ${#MESSAGE} -lt 10 ]; then
  echo "Commit message is too short."
  exit 1
fi

4. `post-commit`

post-commit 钩子在提交完成后被触发。它通常用于通知系统或执行一些后续操作。

示例用途：

发送 Slack 通知
更新文档或版本号

bash 复制代码

#!/bin/sh
# 发送提交成功通知
curl -X POST -H 'Content-type: application/json' --data '{"text":"New commit has been made!"}' YOUR_SLACK_WEBHOOK_URL

5. `pre-push`

pre-push 钩子在 git push 执行之前被触发。它可以用于检查代码质量，确保代码在推送到远程仓库之前没有问题。

示例用途：

检查是否有未通过的测试
验证代码是否符合特定标准

bash 复制代码

#!/bin/sh
# 运行测试套件
npm test
if [ $? -ne 0 ]; then
  echo "Tests failed. Push aborted."
  exit 1
fi

6. `post-receive`

post-receive 钩子在接收推送后触发，适用于远程仓库。这是一个常用的钩子，用于部署代码或发送通知。

示例用途：

自动部署到生产环境
发送邮件通知

bash 复制代码

#!/bin/sh
# 部署到生产环境
git --work-tree=/path/to/deploy --git-dir=/path/to/repo checkout -f

7. `pre-receive`

pre-receive 钩子在推送到远程仓库前被调用。它允许管理员检查推送的内容，决定是否接受。

示例用途：

验证推送的分支
检查推送的代码是否符合公司标准

bash 复制代码

#!/bin/sh
# 检查推送的分支是否为 master
while read oldrev newrev refname; do
  if [ "$refname" = "refs/heads/master" ]; then
    echo "Pushing to master is not allowed."
    exit 1
  fi
done

8. `update`

update 钩子在每次推送到远程时被调用。它可以用于检查分支状态或者执行其他预处理操作。

示例用途：

确保某些分支不能被覆盖
记录推送的信息

bash 复制代码

#!/bin/sh
# 记录每次推送的信息
while read oldrev newrev refname; do
  echo "Pushed to $refname" >> /var/log/git-push.log
done

总结

Git Hooks 是一个强大的工具，可以帮助开发人员在特定事件发生时自动化任务。通过合理配置这些钩子，可以提高代码质量、团队协作效率以及代码管理的规范性。根据项目需求选择合适的钩子，并编写相应的脚本，可以帮助团队在开发流程中减少错误并提升生产力。

Git Hook中常用的钩子有哪些？