Git Hooks 自动化
中等 约 35 分钟
你将构建什么
三个可执行 hook,位于 .git/hooks/,强制提交消息约定、阻止超过 1MB 的文件并在 push 前运行测试。
学习目标
- 将 pre-commit hook 写为 shell 脚本
- 用 commit-msg 强制提交消息格式
- 用 pre-push 自动运行测试
- 使 hook 可执行并测试
前置要求
- 基础 shell 脚本
- Git 提交和 push 工作流
- 文件权限(chmod +x)
步骤
- 1
编写 pre-commit hook
创建 .git/hooks/pre-commit,检查暂存更改中是否有超过 1MB 的文件。若发现,打印错误并 exit 1(阻止提交)。
代码#!/bin/sh # .git/hooks/pre-commit max_size=1048576 # 1MB for file in $(git diff --cached --name-only); do if [ -f "$file" ]; then size=$(wc -c < "$file") if [ $size -gt $max_size ]; then echo "Error: $file is $(($size / 1024))KB, exceeds 1MB limit" exit 1 fi fi done exit 0预期结果
提交 2MB 文件失败并显示错误;小文件正常提交。
- 2
使 hook 可执行
Git 仅运行可执行 hook。用 chmod +x 设置权限,然后通过提交大文件测试。
代码chmod +x .git/hooks/pre-commit # Test: dd if=/dev/zero of=bigfile.bin bs=1M count=2 git add bigfile.bin git commit -m 'Add big file' # Should be blocked预期结果
提交被阻止并显示大小错误。
- 3
编写 commit-msg hook
创建 .git/hooks/commit-msg,强制 'type: message' 格式(如 'feat: add login')。从 $1 读取消息,用 grep 检查,无效则 exit 1。
提示
hook 接收临时提交消息文件路径作为 $1。用 grep -E 匹配模式。
- 4
编写 pre-push hook
创建 .git/hooks/pre-push 运行测试套件。若测试失败,push 被阻止。从 stdin 读取 ref 更新(简单 hook 可忽略)。
提示
运行 npm test 或 make test 并检查退出码。exit 1 阻止 push。
- 5
端到端测试所有 hook
测试每个 hook:尝试错误提交消息(被阻止)、大文件(被阻止)、失败测试(push 被阻止)。然后验证有效提交和 push 成功。
代码# Test commit-msg: git commit -m 'bad message' # blocked git commit -m 'feat: valid message' # succeeds # Test pre-push: # (with a failing test in the suite) git push # blocked if tests fail预期结果
无效提交和 push 被阻止;有效则成功。
自己动手试试
起始代码
#!/bin/sh
# .git/hooks/pre-commit
# TODO: check for large files解决方案代码
#!/bin/sh
for f in $(git diff --cached --name-only); do [ -f "$f" ] && [ $(wc -c < "$f") -gt 1048576 ] && echo "$f too large" && exit 1; done你学到了什么
你用 Git hooks 自动化了质量检查——pre-commit、commit-msg 和 pre-push 是在代码分享前强制约定的标准方式。
相关资源
相关课程
- 提交历史
Hook 强制提交约定。
查阅不认识的术语
新手友好的术语表用大白话解释编程术语——变量、函数、DOM、Promise 等等。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。