git commit触发的hook

git中提供了一组hook,规定了每个hook的名字,以及hook接收的参数个数和每个参数的含义。用户如果要使用hook的话,需要在.git/hooks/目录中创建对应名字的hook文件,赋予该文件可执行权限,用bash或者python或者其它脚本语言来实现该hook具体要做哪些事。hook就是类似于onClick()、onRun()这样的事件,也可以理解成是一组回调函数。

git commit是最常用的命令之一,它可以触发四个hook,分别是pre-commit,prepare-commit-msg,commit-msg和post-commit。从字面上可以猜测到这四个hook分别对应“commit之前”、“准备commit log message的时候”、“生成commit log message的时候”、“commit之后”这四个触发时机。这四个hook也的确是按照这个先后顺序被触发的。如果git commit时使用了-n(等价于--no-verify)参数的话,pre-commit和commit-msg就不会被触发。

pre-commit不接收参数。这个hook可以用来在commit之前检查修改的代码是否符合规范、检查文件名是否含有空格、或者仅仅单纯地输出“hello world”等等,具体想要做什么可以根据实际情况来决定。如果以非0状态退出的话,譬如检测到文件名中有空格,而用户不希望这种文件被commit,在这种情况下执行exit 1,那么git commit会以失败而终止。

prepare-commit-msg接收三个参数。第一个是commit log message所在的文件名,通常是.git/COMMIT_EDITMSG。第二个是commit log message的来源。在《git commit中输入message的几种方式》 中有介绍过-m,不加参数,-c,-C,-F,-t等方式输入commit log message,这些都是不同的来源。如果是-m的话,第二个参数的值是"message";如果是不加参数的话,第二个参数的值是"";如果是-c或-C或者其他情况但加了--amend参数的话,第二个参数的值是"commit";如果是-F的话,第二个参数的值是"message";如果是-t或者设置了commit.template的话,第二个参数的值是"template"。

如果第二个参数不是"commit",那第三个参数值为""。如果第二个参数值是“commit"的话,那第三个参数值就是-c或者-C后面接的那个值,可能是tag name、branch name、HEAD、HEAD^1、具体的某个commit SHA-1等等。有--amend的话,第三个参数值是"HEAD"。

此外,git merge和git cherry-pick可能会触发这个hook。git merge如果是ff(fast-forward) merge那不会触发这个hook,但如果发生no-ff类型的merge,或者git merge --no-ff,那么会触发这个hook,第二个参数值为"merge";git merge --squash && git commit的情况下,第二个参数值为"squash"。git cherry-pick默认情况下会触发这个hook,除非使用了-n(等价于--no-commit)参数,第二个参数值为"message"。

理论上来说,pre-commit中的事情可以放到prepare-commit-msg中来做,但不推荐这么做 。prepare-commit-msg的设计本意是在commit-msg之前编辑message文件用的。譬如,希望在commit log message中记录下当前某个系统的某些状态值(譬如jenkins上某个编译job的环境变量和用户变量),那可以在prepare-commit-msg中对准备用于-F或者-t的文件进行编辑,将那些实时获取的状态值插入到文件中去。然后这个文件的内容会被写入.git/COMMIT_EDITMSG,commit成功以后,这些内容就变成了commit log message的一部分。当然,这些内容也可以在git commit之前组织好,然后在git commit的时候直接用起来。但如果放在hook里来做,就等于封装到了git commit的内部。用户可以根据实际情况考量是否需要用这个hook。同样的,这个hook如果以非0状态退出的话,会使git commit失败而终止。

和prepare-commit-msg比起来,commit-msg使用的场景更多些。这个hook接收一个参数,commit log message所在的文件名,通常是.git/COMMIT_EDITMSG。从这个文件中,可以读取到最终运用于commit log message的内容。比较常见的运用是在这里检查commit log message是否符合事先规定的格式。另外一个实际运用是使用gerrit系统的场合下,git commit时会根据已有的信息生成一个类似commit SHA-1的Change-Id,并将其插入到commit log message中去。生成Change-Id的算法会用到用户编辑完成后的commit log message的内容,所以生成Change-Id的动作不能在commit-msg之前做。同样的,这个hook如果以非0状态退出的话,会使git commit失败而终止。

post-commit在commit完成后被触发,不接收参数。post-commit能够执行,说明git commit已经成功了。接下来可以做很多事,譬如执行git push到一个备份branch上,或者启动编译,或者关机(每天只做一个commit),或者也可以很无聊地git reset --hard回到新生成的commit的parent上(这么做毫无意义),也可以把硬盘格式化掉(再见!)

要试验这四个hook的话,可以在.git/hooks/下创建四个文件,文件名分别为pre-commit,prepare-commit-msg,commit-msg,post-commit,将它们都改为可执行文件。假如要用hook打印每个hook接收了哪些参数:

#!/usr/bash

echo $@

或者

#!/usr/bin/env python

import sys

print sys.argv

然后执行各种git commit看看效果吧。别忘了每个hook的参数列表第0个是hook文件的路径,后面才是接收的参数。hook是一扇门,你的脑洞有多大,门后面的世界就有多大。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容