Git Hook钩子

一、简介

官方文档：https://git-scm.com/docs/githooks/en

官方中文文档：https://git-scm.com/book/zh/v2

Hooks(钩子),是一些存放于$GIT_DIR/hooks文件夹的小脚本,在特定条件下触发动作。当执行git init，几个示例hook将复制到新资源库的hooks文件夹, 但默认情况下他们都是禁用状态，要启用一个hook(钩子),请移除其.sample后缀.

二、Hook类型

https://imweb.io/topic/5b13aa38d4c96b9b1b4c4e9d

http://www.360doc.com/content/16/1014/18/10058718_598431211.shtml

https://blog.51cto.com/u_13187574/2083938

• applypatch-msg
  • 触发时机：由git am触发
  • 接受的参数：
    • 提交的commit msg临时文件路径
  • 可通过--no-verify 略过
  • 如果以非0状态退出，那么git am将在patch(补丁)应用之前取消.
• pre-commit
  • 触发时机：由git commit触发, 在commit msg被创建之前执行.
  • 不接受参数
  • 可通过--no-verify 略过
  • 如果以非0状态退出，将导致git commit被取消
• post-commit
  • 触发时机：由git commit触发, 当commit完成后执行
  • 不接受参数

三、编译工具集成

1、NPM Husky

npm install -g husky

2、Maven

文档：https://blog.csdn.net/leandzgc/article/details/107974276

3、Composer composer-git-hooks

文档：https://packagist.org/packages/brainmaestro/composer-git-hooks

composer global require brainmaestro/composer-git-hooks

composer.json

{
      ".....",
    "extra": {
        "hooks": {
                        "config": {
                  // 配置执行失败时停止（当钩子是一系列命令时，当命令失败时停止执行会很有用）
                "stop-on-failure": ["pre-push"],
                  // 配置自定义hook
                   "custom-hooks": ["pre-flow-feature-start"]
            },
                        "pre-commit": [
                "echo committing as $(git config user.name)",
                "php-cs-fixer fix ." // fix style
            ],
              "pre-flow-feature-start": [
                "echo 'Starting a new feature...'"
            ],
            // verify commit message. ex: ABC-123: Fix everything
            "commit-msg": "grep -q '[A-Z]+-[0-9]+.*' $1",
            "pre-push": [
                "php-cs-fixer fix --dry-run ." // check style
                "phpunit"
            ],
            "post-merge": "composer install"
            "...": "..."
        }
    }
}