Gerrit的commit-msg hook使用指南

短命女 2022-06-16 01:37 378阅读 0赞

Git hooks是Git提供的一种机制，这些hooks能够直接被git commit命令调用，无需开发人员手工设置。

Gerrit提供的commit-msg hook，被调用时，可以自动根据模板编辑commit message，开发人员不必再手工输入commit message。

1.commit-msg hook实现机制

在Gerrit中，该hook实际上就是一个简短的Shell脚本实现。  
commit-msg hook可以接收一个文件名作为参数，该文件中包含写好的commit message，具体逻辑如下：

*  如果已有Change-Id行则什么都不做，返回状态0。
 *  如果没有Change-Id行，则
    
     *  如果有重复的"Signed-of-by"行，如果有则异常退出，返回状态非0。
     *  否则在Signed-off-by行之前追加插入Change-Id行；
     *  或Acked-by行之前追加插入Change-Id行；
     *  或在commit message末尾插入一个空行，然后在空行之后追加插入Change-Id行。

当然，也可以设置Gerrit配置文件gerrit.createChangeId=false禁用该hook。

2.commit-msg hook的两种安装方式

1) 手工为每个Git库安装  
curl -Lo ~/.git/hooks/commit-msg http://gerrit\_server/tools/hooks/commit-msg  
或scp -p -P 29418 myname@gerrit\_server:hooks/commit-msg ~/.git/hooks/

然后，chmod u+x .git/hooks/commit-msg

2) 手工复制一次，自动为每个Git库安装

将 commit-msg hook统一复制到$GIT\_TEMPLATE\_DIR路径下。

这样，后续每次git init创建Git库时，被自动复制到新Git库的.git/hooks/目录下。

3.commit-msg hook使用方式

第一次执行git commit命令时，只要输入具体的commit message，或者根本不必输入任何commit message，而直接采用默认的模板文件内容。git会自动调用commit-msg hook，生成并插入一个Change-Id行。

后续执行git commit --amend时，无需再手工输入任何commit message，甚至可以直接执行如下命令git commit --amend --no-edit。

发表评论取消回复

表情：

评论列表（有 0 条评论，378人围观）

还没有评论，来说两句吧...

相关阅读

相关 gerrit使用指南

关于Change-Id The Change-Id is important for Gerrit to know whether a commit that is ...

墨蓝/ 2024年04月17日 20:47/ 0 赞/ 108 阅读

相关 Java版本控制：Gerrit的使用

文章目录一、Gerrit介绍二、Gerrit和Git区别三、Gerrit 和 Gitlab 区别四、Gerrit工作流程五、Ger

逃离我推掉我的手/ 2024年03月30日 08:44/ 0 赞/ 78 阅读

相关 Gerrit hooks（钩子集成）

gerrit自身实现了 hooks 机制，不同于原生git的 hooks。钩子事件类型文档：https://github.com/GerritCodeReview/

分手后的思念是犯贱/ 2023年10月05日 18:31/ 0 赞/ 30 阅读

相关 Gerrit API接入指南

文档 [https://review.gerrithub.io/Documentation/rest-api.html][https_review.gerrithub.i

古城微笑少年丶/ 2023年10月05日 18:21/ 0 赞/ 47 阅读

相关 Vue3 Hook 实践指南

Vue3 Hook 实践指南文章目录 Vue3 Hook 实践指南 1. 概述 2. 重构状态逻辑 3. 管理副作用

╰半橙微兮°/ 2023年09月26日 20:27/ 0 赞/ 185 阅读

相关【React Hooks 专题】useEffect 使用指南

引言 Hooks 是 React 16.8 的新增特性，至今经历两年的时间，它可以让你在不编写 class 组件的情况下使用 state 以及其他 React 特性。`u

怼烎@/ 2022年08月29日 12:57/ 0 赞/ 385 阅读

相关 Gerrit的commit-msg hook使用指南

Git hooks是Git提供的一种机制，这些hooks能够直接被git commit命令调用，无需开发人员手工设置。 Gerrit提供的commit-msg hook

短命女/ 2022年06月16日 01:37/ 0 赞/ 379 阅读

相关 Gerrit 2.14入门指南

Gerrit是一款免费、开源的代码审查和代码库管理的软件，以Git代码库作为版本控制系统，可以通过命令行、REST和网页界面进行访问。 1.版本截至2017年5月，最新版

港控/mmm°/ 2022年06月16日 01:36/ 0 赞/ 318 阅读

相关 Gerrit之gitbush使用-yellowcong

> 直接使用gerrit的时候，有可能访问不上，需要添加一个config的配置，来指定gerrit服务器的地址，这个是window才会出现的问题，mac和linux不会有这个问

雨点打透心脏的1/2处/ 2022年05月27日 07:06/ 0 赞/ 228 阅读

相关【Gerrit】Gerrit工作流程及使用手册

[http://lipeng1667.github.io/2017/01/18/gerrit-guide/][http_lipeng1667.github.io_2017_01

忘是亡心i/ 2021年06月22日 15:38/ 0 赞/ 646 阅读