前言

这篇文章我们来聚焦.git/hooks/这个熟悉又陌生的文件夹。我不知道读者有没有前端经验，React里也有Hook的概念，但是此hook非彼hook。不懂，我们看下去就知道了。

Git 钩子的基本概念

以下是 Git 钩子（hooks）的详细介绍，包括使用场景、编写示例和注意事项。
Git的钩子（hooks）是一组钩子脚本文件，位于.git/hooks目录下。它们允许你在Git的特定事件（如提交、合并、推送等）发生时，自动执行自定义脚本。默认情况下，Git在.git/hooks目录中会提供一些样例文件，这些样例文件以.sample为扩展名。

Git Hooks 的分类

Git hooks分为客户端钩子和服务器端钩子两类：

  • 客户端钩子：这些钩子在本地仓库运行，主要用于检查或优化提交的代码，确保符合规范，适用于代码风格检查、运行测试等常规操作。
  • 服务器端钩子：这些钩子在远程仓库服务器上运行，通常用于更高级的代码控制，比如防止不合规的代码被推送到共享仓库上。

客户端钩子

这些钩子在本地仓库中运行，通常用于代码质量检查、测试等。

  1. pre-commit：在提交前执行。用于检查代码是否符合要求，比如运行测试、检查代码风格等。

  2. prepare-commit-msg：在创建提交消息时触发，可以用于自动生成提交消息的内容。

  3. commit-msg：在输入提交消息后执行，通常用于检查提交消息的格式。

  4. post-commit：在提交后执行，适合执行通知、更新文档等操作。

  5. pre-rebase：在执行 rebase 之前触发，可以用于阻止不符合要求的变更。

  6. pre-push：在推送之前执行，用于检查推送的内容是否符合标准。

服务器端钩子

这些钩子在远程 Git 服务器上执行，通常用于处理接收到的推送。

  1. pre-receive：在接收到推送之前执行，可以用于检查推送内容的有效性。

  2. update：与 pre-receive 类似，但可以针对每个引用（分支）做检查。

  3. post-receive：在接收到推送后执行，常用于自动部署或发送通知。

编写和使用钩子

  1. 定位钩子目录：
    每个 Git 仓库都有一个 .git/hooks 目录，里面包含了示例钩子（以 .sample 结尾的文件）。你可以选择修改这些示例或新建自己的钩子脚本。
  2. 创建钩子脚本：
    假设我们要创建一个 pre-commit 钩子，确保提交的代码通过 ESLint 检查。你可以在 .git/hooks 目录下创建一个名为 pre-commit 的文件，并写入以下内容：
    1
    2
    3
    4
    5
    6
    7
    #!/bin/bash

    # 运行 ESLint 检查
    if ! eslint .; then
        echo "代码风格检查失败，请修复错误后再提交。"
        exit 1
    fi
  3. 赋予可执行权限：
    运行以下命令为脚本赋予可执行权限：
    1
    chmod +x .git/hooks/pre-commit
  4. 测试钩子：
    进行一次提交，查看钩子是否正常工作。如果 ESLint 检查失败，提交会被阻止，终端会输出相关信息。

常见的使用场景示例

以下是一些常见的钩子使用场景：

  • 代码风格检查：在pre-commit钩子中集成代码检查工具（如ESLint、Prettier），确保提交的代码符合团队约定的风格。
  • 测试自动化：在pre-push钩子中集成测试脚本，确保代码只有在测试通过后才能推送到远程仓库。
  • 提交信息格式化：在commit-msg钩子中验证提交信息是否符合规范，如检查是否包含特定的前缀（如feat、fix）。
  • 自动部署：在服务器端的post-receive钩子中配置自动部署脚本，将代码部署到测试或生产环境。

注意事项

  • 调试钩子：如果钩子不按预期工作，可以在脚本中添加调试信息，比如使用 echo 打印变量和状态信息，帮助定位问题。
  • 共享钩子：钩子通常不在 Git 版本控制中，因为它们存储在 .git/hooks 目录中。你可以在项目中创建一个 hooks 文件夹，将钩子脚本放入其中，然后通过文档指导团队成员手动安装。
  • 钩子的执行权限：确保钩子脚本具有执行权限，否则它不会被执行。
  • 脚本语言：钩子可以用任何可执行的脚本语言编写，常见的有 Bash、Python 等。确保在脚本开头添加合适的解释器声明（如 #!/bin/bash 或 #!/usr/bin/env python3）。

使用Git Hooks的最佳实践

  • 保持钩子简洁：避免在钩子中编写过于复杂的逻辑，过多的操作可能会导致Git操作变慢。
  • 使用脚本管理工具：为了管理和共享钩子，可以使用诸如Husky之类的工具，将钩子文件统一管理，便于团队成员同步。
  • 创建钩子模板：可以在~/.git-templates/hooks目录下放置常用的钩子文件，这样在初始化新的Git仓库时可以自动应用这些钩子。

通过以上详细介绍，应该能够更好地理解和使用 Git 钩子，以自动化和优化你的工作流程。

后记

对，that’s all，就是介绍一下git的hook，我本人其实没有使用过，也是在写这系列的时候才知道有这个东东的，希望未来能用起来吧。