git hook 通過在代碼commit和push之前執(zhí)行一個腳本,來實現(xiàn)一些檢查性工作??抵知。
在.git/hooks目錄下的腳本文件,默認情況下該目錄下有以下文件
applypatch-msg.sample
commit-msg:sample
pre-applypatch.sample
pre-commit.sample
pre-push.sample
pre-rebase.sample
prepare-commit-msg.sample
update.sample
pre-receive.sample
post-update:sample
分割線前面幾種是客戶端鉤子于毙,后面幾種是服務端鉤子
pre-receive可以用來在服務端設置一些代碼檢查的功能趾盐,通過它可以拒絕一些不滿足條件的push哥倔,無情的推行代
碼檢查秸架。
post-receive它發(fā)生在push代碼之后,可以通過CI來觸發(fā)一些測試代碼咆蒿。
若要相應的鉤子生效东抹,編輯腳本文件的內容,去掉.sample后綴即可沃测。腳本若返回非0值缭黔,則相應的git操作不再
往后執(zhí)行。
通過pre-push來舉個??
現(xiàn)在我想在每次push文件之時蒂破,檢查項目中有沒有重復圖片馏谨,來減少不必要的包體積。假設檢查重復圖片的
腳本叫做duplicate_image_detector.py
現(xiàn)在通過客戶端鉤子來實現(xiàn)附迷,因為./.git/hooks下的文件是無法通過git來進行管理惧互,所以只能在客戶端自己將
hook腳本拷貝在./.git/hoos目錄下了哎媚,hook腳本本身可以通過git來管理。
hook腳本如下:
#!/bin/bash
# 圖片檢測
if [ ! -f "./Checkers/duplicate_image_detector.py" ]; then
echo "未集成圖片檢測腳本"
exit 1
fi
如果有多個任務需要處理壹哺,下一個任務需要在上一個任務成功之后再執(zhí)行抄伍,則需要通過:
$? -eq 0
條件來判斷上個任務是否以0結束艘刚,以0結束表示執(zhí)行成功管宵,反之返回非0就代表任務結束,不再繼續(xù)執(zhí)行了攀甚,整
體類似:
#前置任務
#./abc/xyz/xx.rb
if [ $? -eq 0 ]; then
echo "***********xx.rb檢測腳本通過****************"
else
echo "***********xx.rb檢測腳本未通過****************"
exit 1
fi
# 圖片檢測
if [ ! -f "./Checkers/duplicate_image_detector.py" ]; then
echo "未集成圖片檢測腳本"
exit 1
fi
如果為了進一步方便箩朴,再寫一個腳本來檢查當前環(huán)境是否準備好了hook腳本,并進行本地部署:
#!/bin/bash
if ![-f ./shell/pre-push]; then
echo "沒有找到hook的腳本文件"
exit(1)
fi
if [-f ./.git/hooks/pre-push.sample]; then
rm ./.git/hooks/pre-push.sample
fi
cp ./shell/pre-push ./.git/hooks/pre-push
echo "hook設置成功"
每次有新人就讓他手動調用一下這個腳本秋度,最好的方式是希望能夠將.git/hooks/下的腳本納入git管理炸庞。暫時沒有找到解決方案??,或者部署在服務端荚斯,但是需要管理員權限埠居。
針對于上述問題,最后在同事提示下找到一個替換的方案事期。在Xcode的Build Phases中添加一個"Run Script"功能滥壕,在Xcode每次編譯的時候都會執(zhí)行這個腳本。
首先setupHook.sh需要修改一下:
#!/bin/bash
if [ -f ./shell/pre-push ]; then
echo "hook文件存在"
else
echo "hook文件不存在"
exit 1
fi
if [ -f ./.git/hooks/pre-push.sample ]; then
rm ./.git/hooks/pre-push.sample
fi
if [ -f ./.git/hooks/pre-push ]; then
echo "hook已經設置過"
else
echo "hook未設置兽泣,開始設置"
cp ./shell/pre-push ./.git/hooks/pre-push
echo "hook設置成功"
fi
然后再將setupHook.sh腳本添加進去如下所示:
還需要修改一下腳本執(zhí)行權限绎橘,在cmd中執(zhí)行:
chmod u+x setupHook.sh
再Build一下,最后會看到如下輸出:
就說明設置生效了唠倦。
這樣一來称鳞,就不用太擔心某個同學因為忘記設置hook腳本而提交代碼沒有觸發(fā)腳本的問題了,因為提交代碼之前不太可能不會Build代碼稠鼻,但是還是需要在README中顯示的提醒一下冈止,最后一步只是以防萬一。