Git钩子脚本如何检查应急预案

wen 实用脚本 2026-07-14 1

用Git钩子脚本守住应急响应底线：自动化检查应急预案的最佳实践

目录导读

为什么需要Git钩子检查应急预案？
Git钩子脚本的核心原理与分类
应急预案检查脚本的完整设计思路
实战：编写pre-commit钩子检测应急预案完整性
常见问题与问答（FAQ）
从“被动响应”到“主动防御”

为什么需要Git钩子检查应急预案？

在DevOps流程中,代码频繁交付的同时，应急预案（Incident Response Plan）往往被遗忘在文档角落，一旦线上事故爆发，团队因找不到最新预案、预案格式错乱或关键步骤缺失而陷入混乱。Git钩子脚本可以自动在提交或推送前拦截不合规的预案文件，从而：

Git钩子脚本如何检查应急预案

保证每次迭代的预案文件都符合公司标准（如必须包含“影响范围”、“回滚步骤”等字段）
防止手动审核遗漏,实现“左移”质量控制
与CI/CD联动，在部署前确保应急响应准备就绪

Git钩子脚本的核心原理与分类

Git钩子本质上是存储在 .git/hooks/ 目录下的可执行脚本，在特定事件触发时运行，常用的钩子包括：

钩子类型	触发时机	适用于检查应急预案的场景
pre-commit	执行 `git commit` 前	验证当前暂存区中的预案文件格式（如YAML、Markdown）
commit-msg	提交信息写入后	确保提交消息包含“预案变更”标记（便于审计）
pre-push	执行 `git push` 前	远程仓库端二次校验，防止绕过本地钩子

最佳实践：本地使用pre-commit约束，远程仓库配合pre-receive钩子做双重保险。

应急预案检查脚本的完整设计思路

一个优秀的检查脚本应遵循 “四步法则”：

定位文件：识别项目中哪些文件是应急预案（通常按路径或文件名规则，如 incident/*.md）
解析结构：读取文件内容，判断是否包含必需字段（可通过正则、YAML解析库或模板匹配）
执行规则：验证字段值有效性（如“联系人员”不能为空，“恢复时间”需符合时间格式）
产出报告：打印检查结果，失败时阻止提交，并给出具体修改建议

注意：脚本应兼容跨平台（Linux/macOS/Windows），避免使用系统特定的路径分隔符。

实战：编写pre-commit钩子检测应急预案完整性

假设应急预案采用Markdown格式,必须包含以下“元数据块”：

## 预案信息
- 风险等级: [P0|P1|P2]
- 影响范围: [描述]
- 恢复步骤: [至少3步]

步骤1：创建钩子文件

touch .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

步骤2：写入Shell脚本

#!/bin/bash
# pre-commit hook: 检查所有incident目录下Markdown文件
incident_files=$(git diff --cached --name-only --diff-filter=ACM | grep -E "^incident/.*\.md$")
if [ -z "$incident_files" ]; then
    exit 0  # 无变更，直接通过
fi
errors=0
for file in $incident_files; do
    # 检查是否包含风险等级
    if ! grep -qE "\- 风险等级: (P0|P1|P2)" "$file"; then
        echo "❌ $file: 缺少【风险等级】字段（须为P0/P1/P2）"
        errors=$((errors+1))
    fi
    # 检查影响范围
    if ! grep -qE "\- 影响范围: .+" "$file"; then
        echo "❌ $file: 【影响范围】不能为空"
        errors=$((errors+1))
    fi
    # 检查恢复步骤数量
    step_count=$(grep -c "^- 步骤[0-9]:" "$file")
    if [ "$step_count" -lt 3 ]; then
        echo "❌ $file: 恢复步骤需至少3个，当前仅$step_count个"
        errors=$((errors+1))
    fi
done
if [ $errors -gt 0 ]; then
    echo "❗ 应急预案检查未通过，请修复后重新提交"
    exit 1
fi
echo "✅ 所有应急预案文件格式正确"

进阶优化：使用Python脚本配合PyYAML库解析更复杂的YAML格式，支持嵌套字段验证、时间戳校验。

常见问题与问答（FAQ）

Q1: 如何让团队成员都应用同一个钩子？
A: 可以将钩子脚本放在项目根目录的 scripts/git-hooks/ 下，并通过 pre-commit 框架（如 husky for npm、pre-commit for Python）自动配置，或编写 setup-hooks.sh 脚本，开发者运行后复制到 .git/hooks/。

Q2: 钩子检查突然失败，但预案文件确实是正确的？
A: 大概率是钩子中的正则表达式或路径过滤写死了，检查是否有空格差异、编码问题（Windows换行符 \r\n 导致正则匹配失败），建议在脚本开头添加 git config core.autocrlf input 确保换行符统一。

Q3: 能否只检查新增或修改的预案，忽略未变动的文件？
A: 可以，使用 git diff --cached --name-only --diff-filter=ACMR 获取暂存区变更文件，注意ACMR分别代表Add/Copy/Modify/Rename，排除Delete（删除不应阻止提交）。

Q4: 想更严格——要求预案必须与代码变更相关联？
A: 在commit-msg钩子中检查提交信息是否包含 [incident-ref: XXX] 标签，并使用脚本解析关联的issue链接，若提交信息无此标签且暂存区包含预案修改，则拒绝提交。