利用GitLab webhook來實現觸發Jenkins自動操作
本文針對如何設置GitLab以及Jenkins,實現每次GitLab上有提交事件的時候,都能觸發Jenkins執行相應的操作,主要分為以下幾個步驟:
1、新建GitLab測試用例
進入個人GitLab賬號,在右上角的加號中,選出GitLab 的 New Project,可以新建個人的GitLab工程:
其余都走默認的設置,填寫好project的名字,可以創建一個新的project,如圖:
2、設置Jenkins
2.1 首先安裝 GitLab plugin
在“系統管理”->“插件管理”,查看已安裝插件,輸入 GitLab, 看看是否已經安裝,如果沒有,則 查看 可選插件,搜索 GitLab,安裝後重啟即可。
2.2 新建一個測試工程
新建一個job,如圖:
源碼管理選擇Git, 輸入剛剛新建的GitLab的 URL以及個人的API_TOKEN:
目前只有master分支,後續可以根據不同分支對應設置不同的url,監聽不同分支的情況。
在構建觸發器選項中,勾選 Build when a change is pushed to GitLab ,該選項最後的URL就是這個工程的URL路徑,註意如果是本機,則會顯示localhost, 可以將localhost改為個人的ip。
註意這個url, 下一步會用到這個url。可以在工程中設置構建後的操作為執行一句python腳本: print("gitlab webhook jenkins")。點擊應用和保存。
3. 設置GitLab的webhook
GitLab版本在不斷變換,該版本的GitLab,如圖可以找到WebHook的設置入口:
填入的url就是剛剛測試, 勾選push Event,這樣就是每次有push操作的時候,就會觸發webhook,執行填入的url中的操作:
點擊保存,然後點擊Test,可以測試是否可以執行,一般會報這些錯誤:
3.1 anonymous build
不支持匿名build, 這是回到jenkins中,在 系統管理 -> 全局安全管理中, 勾選 匿名用戶具有可讀權限 如圖:
然後點擊應用和保存, 回到GitLab,繼續測試. 如果繼續抱該錯,則進入剛剛構建的工程,點擊 構建觸發器中選中的Build When a change is pushed右下角的高級選項,有一個Secret token,點擊 Generate,會生成一個安全代碼:
復制到webhook中的url下面:
然後保存,再測試,就可以通過,這時候會觸發jenkins執行一次操作:
看看控制臺輸出:
3.2 valid crumb
如果報該錯,則在安全設置中,不勾選 CSRF, 如圖:
測試通過,後續可以在此基礎上拓展, 監聽不同GitLab,同一個GitLab的不同分支的push操作,來分別觸發jenkins端執行對應的操作。
4. GitLab webhook的原理
hook就是在相應的事件下設置鉤子,當相應的事件觸發的時候,比如push event, merge event等操作的時候,就會觸發hook下面的腳本執行,而gitlab webhook, 就是會觸發執行這個webhook的url,類似於前面在jenkins調用中提到的打開url觸發jenkins執行job。
利用GitLab webhook來實現觸發Jenkins自動操作