尽早停止詹金斯管道工作

Question

在我们的 Jenkins 流水线作业中，我们有几个阶段，我希望如果任何阶段失败，则停止构建而不继续进入其他阶段。

以下是其中一个阶段的示例：

stage('Building') {
    def result = sh returnStatus: true, script: './build.sh'
    if (result != 0) {
        echo '[FAILURE] Failed to build'
        currentBuild.result = 'FAILURE'
    }
}

脚本将失败，构建结果将更新，但作业将继续进行到下一个阶段。发生这种情况时如何中止或停止作业？

Answer 1

基本上这就是sh 步骤的作用。如果你没有在变量中捕获结果，你可以运行：

sh "./build"

如果脚本返回非零退出代码，这将退出。

如果你需要先做一些事情，并且需要捕获结果，你可以使用一个 shell 步骤来退出工作

stage('Building') {
    def result = sh returnStatus: true, script: './build.sh'
    if (result != 0) {
        echo '[FAILURE] Failed to build'
        currentBuild.result = 'FAILURE'
        // do more stuff here

        // this will terminate the job if result is non-zero
        // You don't even have to set the result to FAILURE by hand
        sh "exit ${result}"  
    }
}

但以下内容会给你同样的结果，但看起来更理智

stage('Building') {
    try { 
         sh './build.sh'
    } finally {
        echo '[FAILURE] Failed to build'
    }
}

也可以在代码中调用 return。但是，如果您在 stage 内，它只会退出该阶段。所以

stage('Building') {
   def result = sh returnStatus: true, script: './build.sh'
   if (result != 0) {
      echo '[FAILURE] Failed to build'
      currentBuild.result = 'FAILURE'
      return
   }
   echo "This will not be displayed"
}
echo "The build will continue executing from here"

不会退出工作，但是

stage('Building') {
   def result = sh returnStatus: true, script: './build.sh'
}
if (result != 0) {
  echo '[FAILURE] Failed to build'
  currentBuild.result = 'FAILURE'
  return
}

会的。

Answer 2

由于 Jenkins v2 这应该也可以工作

error('Failed to build')

作业将结束于：

ERROR: Failed to build
Finished: ERROR

Answer 3

实现此行为的另一种方法是抛出异常。事实上，这正是 Jenkins 本身所做的。这样，您还可以将构建状态设置为ABORTED 或FAILURE。此示例中止构建：

stage('Building') {
    currentBuild.rawBuild.result = Result.ABORTED
    throw new hudson.AbortException('Guess what!')
    echo 'Further code will not be executed'
}

输出：

[Pipeline] stage
[Pipeline] { (Building)
[Pipeline] }
[Pipeline] // stage
[Pipeline] End of Pipeline
ERROR: Guess what!
Finished: ABORTED