[原創]升級Gerrit的commit-msg,檢查git commit時必須填寫開發任務編號TaskID


公司使用git+gerrit+jenkins進行持續集成實踐,其中gerrit用來進行Code Review。另外我們自己研發了一套敏捷項目管理系統TPM(TeamPlus Management),用來管理開發任務和電子看板。此時有一個需求,希望開發人員提交的代碼能夠關聯到TPM上的開發任務,這樣就能實現需求與代碼的關聯,實現 需求->backlog->userstory->task->code->build->test->deploy->prod 的全流程數據關聯。

目前的一個方式是在開發人員提交代碼的同時,在comments中指定TaskID,其中TaskID是TPM系統中開發任務編號。但是很多時候開發人員提交代碼是,忘記在comments log中指定TaskID,導致數據缺失,不能有效輔助研發過程改進。

為此,考慮參考Gerrit的commit-msg的方式,在commit代碼同時,檢查comments log中是否有指定合法的TaskID。(Gerrit的commit-msg,就是在commit代碼的同事,給comments log增加一個Change-ID編號)

 

首先,修改commit-msg,增加TaskID的檢查。

# Check for if missing a unique TaskID related with TPM

#

check_TaskID() {

 

COMMIT_FILE=$MSG

COMMIT_MSG=$(cat $MSG)

TASK_ID=$(echo "$COMMIT_MSG" | grep -Eo "#task[A-Za-z0-9]+")

if [ -z "$TASK_ID" ]; then

echo "[ERROR] Please add TPM TaskID comment logs with a format like 'comment logs #task20180623001'"

exit 1

else

echo "[INFO] StoryId=["$TASK_ID"]"

fi

}

 

# Check for, and add if missing, a unique Change-Id

#

add_ChangeId() {

...

...

...

 

check_TaskID

add_ChangeId

 

其次,是替換舊的commit-msg文件。

檢索了一遍gerrit-site目錄,沒有發現commit-msg文件,懷疑是在gerrit.war中。解開gerrit.war,仍然沒有發現commit-msg文件,懷疑實在某個依賴lib中。我們用的gerrit版本是2.12.8。翻了一下gerrit的源代碼,commit-msg是在gerrit-server/src/main/resources/com/google/gerrit/server/tools/root/hooks/commit-msg,推測是在gerrit-server的依賴lib中。解開gerrit-server-server.jar后,果然發現commit-msg。

之后有兩種辦法替換:

1、重新編譯gerrit源碼。覺得太麻煩,放棄。

2、依次解壓gerrit.war和gerrit-server-server.jar,修改commit-msg,再用jar命令依次打包gerrit-server-server.jar和gerrit.war。

注意打gerrit.war的時候,需要指定Manifest,指定gerrit.war的Main-Class: Main,否則java -jar gerrit.war啟動的時候找不到MainClass。

 

最后,升級修改后的gerrit。

網上找一找gerrit版本升級的網頁有一堆。務必注意,升級之前一定要備份gerrit-site。

1、停止gerrit。 cd gerrit-site/bin; sh gerrit.sh stop

2、備份gerrit-site

3、啟動新的gerrit。  java -jar new-gerrit.war init -d gerrit-site

之后基本上一路回車就行。這個過程會替換gerrit-site/bin/gerrit.war,並會重新配置一遍gerrit。

 

驗證效果

1、啟動gerrit。 cd gerrit-site/bin; sh gerrit.sh start

2、打開 http://gerrit地址/tools/hooks/commit-msg,查看是否是修改以后的文件。

3、git clone項目測試。

:~/code>git clone ssh://[項目地址] && scp -p -P 29418 [gerrit地址]:hooks/commit-msg AgileMng/.git/hooks/

Cloning into 'AgileMng'...

remote: Counting objects: 1952, done

remote: Finding sources: 100% (1952/1952)

remote: Total 1952 (delta 918), reused 1870 (delta 918)

Receiving objects: 100% (1952/1952), 1.17 MiB, done.

Resolving deltas: 100% (918/918), done.

commit-msg                                                                                                                               100% 4946     4.8KB/s   00:00   

 

:~/code/AgileMng>touch 1

:~/code/AgileMng>git add 1

:~/code/AgileMng>git status

# On branch master

# Changes to be committed:

#   (use "git reset HEAD <file>..." to unstage)

#

#       new file:   1

#

 

:~/code/AgileMng>git commit -m "add new file 1"

[ERROR] Please add TPM TaskID in comment logs with a format like 'comment logs #task20180623001'

 

:~/code/AgileMng>git commit -m "add new file 1 #task20180618 new file 1"

[INFO] TaskId=[#task20180618]

[master 48daaed] add new file 1 #task20180618 new file 1

 1 file changed, 0 insertions(+), 0 deletions(-)

 create mode 100644 1


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM