昨天我使用 Git 钩子为项目设置了 Commit message 提交校验，之前我未曾细看过 Git 钩子相关内容，以本文记录下 Git 钩子相关内容。

什么是 Git 钩子

Git 钩子（Git hooks）是一种在特定事件发生时自动执行自定义脚本的机制。

它们允许开发者在 Git 工作流程的不同阶段插入自定义操作。

钩子可以用于执行各种任务，如验证提交信息、自动化测试、代码格式化等。

钩子类型

客户端钩子

  • pre-commit: 在提交之前执行，可以用来检查代码质量或格式

  • commit-msg: 在输入提交信息时执行，用于验证提交信息的格式

  • post-commit: 提交后执行，可以用于发送通知或更新其他系统

服务器端钩子

  • pre-receive: 在接收推送之前执行，通常用于验证提交

  • post-receive: 在推送完成后执行，可以用于更新部署或通知系统

钩子的使用场景

  • 强制提交信息格式: 确保开发者遵循一致的提交信息格式

  • 自动化测试: 在提交之前运行单元测试，以确保代码质量

  • 代码风格检查: 确保代码符合预定义的风格指南

  • 部署: 在代码推送到服务器后自动进行部署

配置钩子

钩子脚本通常位于 Git 仓库的 .git/hooks 目录中。可以根据需要创建或编辑这些脚本。

钩子脚本是普通的可执行文件，使用任何支持的编程语言编写（如 Bash、Python、Ruby 等）。

注意事项

  • 钩子是本地配置，不会随仓库一起共享。为了让团队中的每个人都能使用相同的钩子，通常会在仓库中维护一个钩子模板，并使用 Git 配置来指向该模板

  • 不正当使用钩子可能会导致提交过程变慢，需要谨慎设计钩子脚本