使用Git Hooks改進Go開發流程

Git Hooks是一種非常強大的改進開發工作流的方法,不需要記住運行額外的腳本或執行額外的任務。本文介紹如何在項目倉庫中自定義git Hooks實現對Go代碼的格式化。

這個例子可以讓你知道如何在自己的的項目中使用git Hooks。

實際案例

這方面的一個例子來自我當前的一個項目,在這個項目中,團隊必須在將密匙文件推入項目倉庫之前對它們進行加密。加密文件本身就一行代碼的事,但由于我們項目中密匙文件的數量大了,要記住每個修改過的密匙文件,變成了一個挑戰,我們會為沒有重新加密密匙文件而抓狂。

解決方案

當我們試圖解決這個問題時,我們能夠使用的工具相當有限,并且我們不希望使用那些可能對部分有自己開發習慣的團隊成員造成影響。這就是Git Hooks發揮作用的地方了。有了Git Hooks,可以定義一個簡單的“pre-commit” hook腳本,它將自動執行對未加密的密匙文件的加密,并添加到commit任務中去。可以通過在hooks/目錄中創建這些hooks,讓它成為團隊開發流程中的可選插件,這樣如果想把這些hooks添加到他們自己的開發流程中的話,可以通過一個簡單的命令(git config core.hooksPath hooks)配置即可。

創建Git Hook

Hooks實際上創建起來非常簡單,因為它們只是在特定目錄中具有特定名稱的bash腳本。當您下次執行給定的git命令時,它將自動執行這個bash腳本,前提是該腳本是對應特定命令的正確命名文件。

先進入到項目的代碼倉庫進入.git隱藏目錄,可以看到如下目錄和文件:

root@CloudEdge1:/home/zjlab/goRestAPI-docker/.git# ls -l
total 48
drwxr-xr-x  2 root root 4096 Feb 24 09:37 branches
-rw-r--r--  1 root root  261 Feb 24 10:51 COMMIT_EDITMSG
-rw-r--r--  1 root root  275 Feb 24 09:37 config
-rw-r--r--  1 root root   73 Feb 24 09:37 description
-rw-r--r--  1 root root   21 Feb 24 09:37 HEAD
drwxr-xr-x  2 root root 4096 Feb 24 09:37 hooks
-rw-r--r--  1 root root  642 Feb 24 10:45 index
drwxr-xr-x  2 root root 4096 Feb 24 09:37 info
drwxr-xr-x  3 root root 4096 Feb 24 09:37 logs
drwxr-xr-x 19 root root 4096 Feb 24 10:45 objects
-rw-r--r--  1 root root  112 Feb 24 09:37 packed-refs
drwxr-xr-x  5 root root 4096 Feb 24 09:37 refs

上面有個hooks目錄,就是存放我們將要定義的Git hooks腳本的目錄:

root@CloudEdge1:/home/zjlab/goRestAPI-docker/.git/hooks# ls -l
total 48
-rwxr-xr-x 1 root root  478 Feb 24 09:37 applypatch-msg.sample
-rwxr-xr-x 1 root root  896 Feb 24 09:37 commit-msg.sample
-rwxr-xr-x 1 root root 3327 Feb 24 09:37 fsmonitor-watchman.sample
-rwxr-xr-x 1 root root  189 Feb 24 09:37 post-update.sample
-rwxr-xr-x 1 root root  424 Feb 24 09:37 pre-applypatch.sample
-rwxr-xr-x 1 root root 1642 Feb 24 09:37 pre-commit.sample
-rwxr-xr-x 1 root root 1492 Feb 24 09:37 prepare-commit-msg.sample
-rwxr-xr-x 1 root root 1348 Feb 24 09:37 pre-push.sample
-rwxr-xr-x 1 root root 4898 Feb 24 09:37 pre-rebase.sample
-rwxr-xr-x 1 root root  544 Feb 24 09:37 pre-receive.sample
-rwxr-xr-x 1 root root 3610 Feb 24 09:37 update.sample

下面我們創建格式化Go代碼的bash腳本,并命名為pre-commit,因為我們是針對git commit命令創建的hooks,也就是在提交代碼前,對Go文件進行格式化。

.git/hooks/pre-commit

#!/bin/bash

echo "Test Hook"

## this will retrieve all of the .go files that have been 
## changed since the last commit
STAGED_GO_FILES=$(git diff --cached --name-only -- '*.go')

## we can check to see if this is empty
if [[ $STAGED_GO_FILES == "" ]]; then
    echo "No Go Files to Update"
## otherwise we can do stuff with these changed go files
else
    for file in $STAGED_GO_FILES; do
        ## format our file
        go fmt $file
        ## add any potential changes from our formatting to the 
        ## commit
        git add $file
    done
fi

現在我們保存任何go代碼文件并執行add和commit提交命令,都會自動將使用go fmt命令對go文件進行格式化,然后再提交。

在團隊中分發Git Hooks

因為我們的Git Hook保存在hooks/目錄中,并不能自動分發到其他的開發者。需要在項目中創建一個.githooks/目錄,然后將前面的pre-commit腳本保存到這個目錄。這樣就可以同其他文件一樣提交并跟蹤這個腳本,如果要讓這個hooks腳本在其他開發者的環境中生效,還需要執行如下命令:

$ git config core.hooksPath .githooks
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,622評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,716評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,746評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,991評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,706評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,036評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,029評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,203評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,725評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,451評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,677評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,161評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,857評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,266評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,606評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,407評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,643評論 2 380

推薦閱讀更多精彩內容