跳過 Jenkins 管道中的一個階段

一、概述

Jenkins 是一種開源自動化服務器，可促進軟件應用程序的構建、測試和部署。 Jenkins 提供了腳本化管道語法，允許用戶使用 Groovy 腳本語言編寫Jenkins 管道。 Jenkins 中的腳本化管道具有很強的適應性，可以定制以滿足特定要求。

在腳本化管道中，階段被佈置為 Jenkins 將執行的一系列步驟。每個階段對應於流程中的一個不同階段，例如構建、測試和部署應用程序。在某些情況下，可能需要跳過管道中的特定階段。

在本教程中，我們將討論在 Jenkins 腳本管道中跳過階段的不同解決方案。

2. 流水線作業中跳過階段的重要性

出於多種原因，跳過流水線作業中的階段可能很重要。加快管道執行時間非常有用。有時某些階段可能是不必要的或需要很長時間才能運行，從而減慢整個管道。

跳過管道作業中的階段可能會通過減少完成作業所需的時間來幫助加快開發過程。如果管道包含測試階段，開發人員可能希望在本地開發期間跳過此階段，以便更快地獲得有關其更改的反饋。

3. 使用when指令

Jenkins 腳本管道中的when指令允許開發人員定義一個條件，該條件必須為true才能執行特定階段。我們可以使用when指令來自定義管道作業的執行。我們可以將when指令應用於階段、步驟或代碼塊：

pipeline {
 agent any
 parameters {
 booleanParam(name: 'skip_test', defaultValue: false, description: 'Set to true to skip the test stage')
 }
 stages {
 stage('Build') {
 steps {
 sh 'echo "Building application"'
 // Add build steps here
 }
 }
 stage('Test') {
 when { expression { params.skip_test != true } }
 steps {
 sh 'echo "Testing application"'
 // Add test steps here
 }
 }
 stage('Deploy') {
 steps {
 sh 'echo "Deploying application"'
 // Add deployment steps here
 }
 }
 }
 }

上面的 Jenkins 流水線自動化了應用程序的持續集成/持續部署過程。它定義了三個階段—— Build 、 Test和Deploy 。

在Build階段，我們使用echo語句來指示我們正在構建應用程序。 Test階段是偶然的，只有在布爾參數skip_test為false時才會執行。如果skip_test是true ，測試階段將被完全省略。 Test階段包括一個echo語句，通知我們應用程序正在測試中。 Deploy階段涉及部署應用程序。

總的來說，Jenkins 管道是一種自動化 CI/CD 並節省時間和資源的高效方式。

4.使用input step

Jenkins 腳本化管道允許開發人員在等待用戶輸入時暫停管道作業。這在開發人員希望能夠選擇是否跳過管道中的特定階段的情況下很有用：

pipeline {
 agent any
 stages {
 stage('Build') {
 steps {
 sh 'echo "Building the application"'
 // Add steps to build the application
 }
 }
 stage('Test') {
 steps {
 input message: 'Want to skip the test stage?', ok: 'Yes',
 parameters: [booleanParam(name: 'skip_test', defaultValue: false)], timeout: time(minutes: 5))
 script {
 if(params.skip_test) {
 sh 'echo "Testing the application"'
 return
 }
 }
 // Add steps to test the application
 }
 }
 stage('Deploy') {
 steps {
 sh 'echo "Deploying the application"'
 // Add steps to deploy the application
 }
 }
 }
 }

stages 塊定義了流水線的三個階段。 Build階段包含構建應用程序的指令，而Deploy階段包含部署應用程序的指令。 Test階段涉及一個輸入步驟，提示用戶確定是否跳過測試階段。腳本塊檢查輸入參數skip_test並僅在skip_test為false時執行測試應用程序的命令。

通過將它們添加到步驟塊，每個階段可以有多個步驟。為了說明，我們可以將構建或部署步驟添加到相應的階段。總的來說，這個管道定義了一個構建、測試和部署應用程序的工作流，同時提供了跳過Test階段的選項。

5.使用函數控制流水線

在 Jenkins 腳本管道中跳過階段的第三種方法需要使用一個函數來調節管道的流程。當我們需要跳過管道中的幾個階段並且我們希望避免多次復制相同的代碼時，這種方法是有利的。

基本概念是創建一個函數，該函數接受階段名稱和一個布爾參數以指定是否跳過該階段。該函數隨後在if語句中包含階段的步驟，僅當skip參數為false時才執行這些步驟：

pipeline {
 agent any
 parameters {
 booleanParam(name: 'skip_test', defaultValue: false, description: 'Set to true to skip the test stage')
 }
 stages {
 stage('Build') {
 steps {
 sh 'echo "Building the application"'
 }
 }
 stage('Test') {
 steps {
 execute_stage('Test', params.skip_test)
 }
 }
 stage('Deploy') {
 steps {
 sh 'echo "Deploying the application"'
 }
 }
 }
 }

 def execute_stage(stage_name, skip) {
 stage(stage_name) {
 if(skip) {
 echo "Skipping ${stage_name} stage"
 return
 }
 // Add steps to test the application
 }
 }

上面的管道作業包含一個階段塊，它建立了三個管道階段。 Build階段包含執行 shell 命令以echo消息“Building application”的唯一步驟。 Test階段使用名為execute_stage自定義函數通過提供階段名稱和skip_test參數的值作為參數來執行測試階段。 execute_stage函數最初生成一個具有指定階段名稱的新階段，然後評估 skip 是否為true 。

默認情況下，如果skip為true ，此函數將跳過該階段，打印一條消息並結束而不執行任何進一步的步驟。如果skip為false ，則函數繼續執行集成到execute_stage函數中的任何其他步驟。使用此管道，我們可以通過將skip_test設置為true來跳過Test階段，這將在執行期間省略Test階段。

六，結論

在本文中，我們討論了在 Jenkins 腳本管道中跳過階段的三種不同解決方案。首先，我們探索了when directive根據條件跳過階段。之後，我們使用input step提示用戶跳過一個階段。最後，我們查看了一個自定義函數來控制管道的流動。

我們還可以在 GitHub 上找到用於跳過 Jenkins 管道作業階段的腳本。