gitlab HOOKS钩子你需要了解的知识

了解Git的Hook机制

 

gitLab hooks大体上分为两类:客户端钩子和服务器端钩子,如下 先从一张图了解一下Hooks的阶段

 

1.1: 客户端钩子

pre-commit

钩子在键入提交信息前运行。 它用于检查即将提交的快照,例如,检查是否有所遗漏,确保测试运行,以及核查代码。 如果该钩子以非零值退出,Git 将放弃此次提交,不过你可以用 git commit --no-verify 来绕过这个环节。 你可以利用该钩子,来检查代码风格是否一致(运行类似 lint 的程序)、尾随空白字符是否存在(自带的钩子就是这么做的),或新方法的文档是否适当。

prepare-commit-msg

钩子在启动提交信息编辑器之前,默认信息被创建之后运行。 它允许你编辑提交者所看到的默认信息。 该钩子接收一些选项:存有当前提交信息的文件的路径、提交类型和修补提交的提交的 SHA-1 校验。 它对一般的提交来说并没有什么用;然而对那些会自动产生默认信息的提交,如提交信息模板、合并提交、压缩提交和修订提交等非常实用。 你可以结合提交模板来使用它,动态地插入信息。

commit-msg

钩子接收一个参数,此参数即上文提到的,存有当前提交信息的临时文件的路径。 如果该钩子脚本以非零值退出,Git 将放弃提交,因此,可以用来在提交通过前验证项目状态或提交信息。 在本章的最后一节,我们将展示如何使用该钩子来核对提交信息是否遵循指定的模板。

post-commit

钩子在整个提交过程完成后运行。 它不接收任何参数,但你可以很容易地通过运行 git log -1 HEAD 来获得最后一次的提交信息。 该钩子一般用于通知之类的事情。

post-applypatch

运行于提交产生之后,是在 git am 运行期间最后被调用的钩子。 你可以用它把结果通知给一个小组或所拉取的补丁的作者。 但你没办法用它停止打补丁的过程。

pre-rebase

 钩子运行于变基之前,以非零值退出可以中止变基的过程。 你可以使用这个钩子来禁止对已经推送的提交变基。 Git 自带的 pre-rebase 钩子示例就是这么做的,不过它所做的一些假设可能与你的工作流程不匹配。

post-rewrite

钩子被那些会替换提交记录的命令调用,比如 git commit --amend 和 git rebase(不过不包括 git filter-branch)。 它唯一的参数是触发重写的命令名,同时从标准输入中接受一系列重写的提交记录。 这个钩子的用途很大程度上跟 post-checkout 和 post-merge 差不多。

在 git checkout 成功运行后,post-checkout 钩子会被调用。你可以根据你的项目环境用它调整你的工作目录。 其中包括放入大的二进制文件、自动生成文档或进行其他类似这样的操作。

在 git merge 成功运行后,post-merge 钩子会被调用。 你可以用它恢复 Git 无法跟踪的工作区数据,比如权限数据。 这个钩子也可以用来验证某些在 Git 控制之外的文件是否存在,这样你就能在工作区改变时,把这些文件复制进来。

pre-push

钩子会在 git push 运行期间, 更新了远程引用但尚未传送对象时被调用。 它接受远程分支的名字和位置作为参数,同时从标准输入中读取一系列待更新的引用。 你可以在推送开始之前,用它验证对引用的更新操作(一个非零的退出码将终止推送过程)。

Git 的一些日常操作在运行时,偶尔会调用 git gc --auto 进行垃圾回收。 pre-auto-gc 钩子会在垃圾回收开始之前被调用,可以用它来提醒你现在要回收垃圾了,或者依情形判断是否要中断回收。

 

 

1.2: 服务器端钩子

pre-receive

处理来自客户端的推送操作时,最先被调用的脚本是 pre-receive。 它从标准输入获取一系列被推送的引用。如果它以非零值退出,所有的推送内容都不会被接受。 你可以用这个钩子阻止对引用进行非快进(non-fast-forward)的更新,或者对该推送所修改的所有引用和文件进行访问控制。

update

update 脚本和 pre-receive 脚本十分类似,不同之处在于它会为每一个准备更新的分支各运行一次。 假如推送者同时向多个分支推送内容,pre-receive 只运行一次,相比之下 update 则会为每一个被推送的分支各运行一次。 它不会从标准输入读取内容,而是接受三个参数:引用的名字(分支),推送前的引用指向的内容的 SHA-1 值,以及用户准备推送的内容的 SHA-1 值。 如果 update 脚本以非零值退出,只有相应的那一个引用会被拒绝;其余的依然会被更新。

post-receive

post-receive 挂钩在整个过程完结以后运行,可以用来更新其他系统服务或者通知用户。 它接受与 pre-receive 相同的标准输入数据。 它的用途包括给某个邮件列表发信,通知持续集成(continous integration)的服务器, 或者更新问题追踪系统(ticket-tracking system) —— 甚至可以通过分析提交信息来决定某个问题(ticket)是否应该被开启,修改或者关闭。 该脚本无法终止推送进程,不过客户端在它结束运行之前将保持连接状态, 所以如果你想做其他操作需谨慎使用它,因为它将耗费你很长的一段时间。

 

2: 如何使用Hooks

2.1:客户端Hooks使用

1:项目的hooks如下,地址为当前项目的.git/hooks目录下

ps:只有去掉.sample后缀才能生效,并且不能全局配置 只能在配置的项中生效

2:开始一个简单的Demo-检查commit信息的长度不能小于10

ps:在.git/hooks目录下找到commit-msg.sample,重命名为commit-msg,脚本如下
#!/bin/sh
MSG=`awk '{printf("%s",$0)}' $1`
if [ ${#MSG} -lt 10 ]  
  then
    echo "-------------------------------------------------------------------"
    echo "commit message 只有${#MSG}字符"
    echo "message的长度不能小于10, 本次提交失败,请完善commit message,再提交"
    echo "-------------------------------------------------------------------"
    exit 1
fi

 

>>执行效果如下 客户端的hooks一般会在push到服务端之前就触发相关操作

 

2.2:服务端Hooks使用

1:修改配置,并创建一个pre-recevie勾子

# 1: 创建custom_hooks_dir文件夹(目录任意)并创建pre-receive.d,update.d,post-receive.d三个文件
mkdir -p /opt/gitlab/custom_hooks/{pre-receive.d,update.d,post-receive.d}

# 2:修改文件的执行权限
chown +x /opt/gitlab/custom_hooks/

# 3: 创建pre-recevie文件并赋予可执行权限
cd /opt/gitlab/custom_hooks/pre-receive.d
touch pre-recevie
chmod 777 pre-recevie

# 4: 执行gitlab reconfigure
sudo gitlab-ctl reconfigure 

2:执行一个简单的demo-提交成功后输出一段文本

ps:如下脚本 提交成功后输出一段文本
#!/bin/bash

echo "您已经提交成功了"
ps:执行结果如下;我们可以发现跟2.1相比客户端hooks与服务端hooks可以有同样的功能 但是执行的阶段是不一样的

 

3: [探讨]GitLab的Hooks可以做些什么

1:结合自身在工作中的实践我认为可以做这些事情

1:代码提交的Commit Message规则检查
2:版本命名规则检查
3:代码基本的规范检查(例如:检查一下注释、代码中是否有备注author等信息)
4:代码的质量检查(可以结合SonrQube做代码的质量检查,从源头防止一些不健康的代码被提交到代码仓库)
5:测试环境的自动化部署(当然这个Jenkins结合git的webhooks也可以做到)

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章