Jenkins高階篇之Pipeline-7-Declarative Pipeline指令:triggers/stage/tool
本篇繼續學習Declarative Pipeline的相關指令,本篇學習三個指令,分別是觸發器(triggers),stage和tool。觸發器主要是方便週期控制自動化提交,stage是在stages{...}下的一個指令,我們平臺的大部分程式碼都在stage內完成,tool主要就是為了三大工具(jdk, gradle,maven)提供環境變數服務的。
指令1:triggers
該triggers指令定義了Pipeline應重新觸發的自動化方式。對於與原始碼整合的Pipeline,如GitHub或BitBucket,triggers可能不需要基於webhook的整合可能已經存在。目前有三個可用的觸發器是cron和pollSCM 和 upstream。
這個triggers是觸發器的意思,所以這塊是設定什麼條件下觸發pipeline程式碼執行,以及觸發的頻率。看到這裡,如果你學習過Jenkins UI功能部分,你應該記得有下面這個圖,用來控制輪詢頻率的,特別適合週期的自動化提交。
這篇介紹的觸發器知識點就和這個有關。先記住這個點,在一個pipeline{…}程式碼中,只執行出現一次triggers{…},而且這個指令不是必須存在的。
cron
接受一個cron風格的字串來定義Pipeline應重新觸發的常規間隔,例如: triggers { cron('H 4/* 0 0 1-5') }
pollSCM
接受一個cron風格的字串來定義Jenkins應該檢查新的源更改的常規間隔。如果存在新的更改,則Pipeline將被重新觸發。例如:triggers { pollSCM('H 4/* 0 0 1-5') }
upstream
接受逗號分隔的作業字串和閾值。 當字串中的任何作業以最小閾值結束時,將重新觸發pipeline。例如:triggers { upstream(upstreamProjects: 'job1,job2', threshold: hudson.model.Result.SUCCESS) }
舉例一個可能利用scm的場景,如果一個公司做到了很好的程式碼覆蓋測試,一般都會,如果監控到有人提交程式碼,就會自動化觸發啟動相關的單元測試。這個場景就是適合在pipeline程式碼裡使用triggers指令,下面程式碼舉例一個pollSCM的基本使用。
pipeline { agent any triggers { pollSCM (‘H H(9-16)/2 * * 1-5)’) } stages { stage('Example') { steps { echo 'Hello World' } } } }
解釋下“H H(9-16)/2 * * 1-5)”的含義,這個你可以在上面截圖這個頁面點選右側這個問號,出來具體含義。第一步,先根據空格,把字串切割成5段。這5部分在下面這張圖有解釋。
所以,H H(9-16)/2 * * 1-5) 的含義就是:
第一部分“H” 表示hash,記住不是表示hour,是一個雜湊值,含義就是在一個小時之內,會執行一次,但是這次是一個雜湊值,而且不會併發執行。
第二部分“H(9-16)/2”,表示白天在早上9點到下午5點,每間隔2小時執行一次。
第三部分“*“,每天執行
第四部分“*“表示每月執行
第五部分“1-5“ 表示週一到週五執行
所以上面這個表示式“H H(9-16)/2 * * 1-5) “的含義就是,在每個月的週一到週五的白天,從早上9點到下午5點,每間隔兩個小時去觸發一次自動化構建。 這個就比較適合,我們每天上班,間隔兩個小時去跑一次單元自動化測試。間隔時間長短,取決伺服器壓力和業務具體場景。
指令2:stage
該stage指令在該stages部分中,應包含步驟部分,可選agent部分或其他特定於階段的指令。實際上,Pipeline完成的所有實際工作都將包含在一個或多個stage指令中。
特點:stage一定是在stages{…}裡面,一個pipeline{…}中至少有一個stages{…}和一個stage{…}.這裡多說一句,一個stage{…}中至少有一個steps{…}。Stage{…}還有一個特點就是,裡面有一個強制的字串引數,這個字串引數就是描述這個stage是幹嘛的,這個字串引數是不支援變數的,只能你自己取名一個描述欄位。
程式碼舉例:
pipeline {
agent any
stages {
stage('Example') {
steps {
echo 'Hello World'
}
}
}
}
指令3:tool
定義自動安裝和放置工具的部分PATH。如果agent none指定,這將被忽略。
特點:
只支援定義maven jdk gradle三種工具的環境變數。
程式碼舉例:
pipeline {
agent any
tools {
jdk 'jdk8'
}
stages {
stage('Example') {
steps {
sh 'java -version'
}
}
}
}
注意:工具名稱必須在Jenkins 管理Jenkins → 全域性工具配置中預配置。例如,上面程式碼我寫了jdk,那麼我必須在jenkins管理的全域性工具配置中有jdk配置。