Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Jenkins: Ignore failure in pipeline build step

With jenkins build flow plugin this was possible:

ignore(FAILURE){
    build( "system-check-flow" )
}

How to do this with Declarative Pipeline syntax?

like image 482
lenkovi Avatar asked May 17 '17 10:05

lenkovi


People also ask

How do I ignore failed stage in Jenkins pipeline?

To ignore a failed step in declarative pipeline you basically have two options: Use script step and try-catch block (similar to previous proposition by R_K but in declarative style)

How do you skip a stage in Jenkins pipeline?

You can skip stages in declarative pipelines using when , so the following should work. stages { stage('Deploy') { when { equals expected: true, actual: Deploy } steps { // ... } } } If it should be totally invisible in the review pipeline, then use scripted pipelines and wrap the stage with an if statement.

How do I catch exceptions in Jenkins pipeline?

try/catch is scripted syntax. So any time you are using declarative syntax to use something from scripted in general you can do so by enclosing the scripted syntax in the scripts block in a declarative pipeline. So your try/catch should go inside stage >steps >script.


4 Answers

To ignore a failed step in declarative pipeline you basically have two options:

  1. Use script step and try-catch block (similar to previous proposition by R_K but in declarative style)
stage('someStage') {     steps {         script {             try {                 build job: 'system-check-flow'             } catch (err) {                 echo err.getMessage()             }         }         echo currentBuild.result     } } 
  1. Use catchError
stage('someStage') {     steps {         catchError {             build job: 'system-check-flow'         }         echo currentBuild.result     } } 

In both cases the build won't be aborted upon exception in build job: 'system-check-flow'. In both cases the echo step (and any other following) will be executed.

But there's one important difference between these two options. In first case if the try section raises an exception the overall build status won't be changed (so echo currentBuild.result => SUCCESS). In the second case you overall build will fail (so echo currentBuild.result => FAILURE).

This is important, because you can always fail the overall build in first case (by setting currentBuild.result = 'FAILURE') but you can't repair build in second option (currentBuild.result = 'SUCCESS' won't work).

like image 186
user1053510 Avatar answered Sep 23 '22 10:09

user1053510


In addition to simply making the stage pass, it is now also possible to fail the stage, but continue the pipeline and pass the build:

pipeline {     agent any     stages {         stage('1') {             steps {                 sh 'exit 0'             }         }         stage('2') {             steps {                 catchError(buildResult: 'SUCCESS', stageResult: 'FAILURE') {                     sh "exit 1"                 }             }         }         stage('3') {             steps {                 sh 'exit 0'             }         }     } } 

In the example above, all stages will execute, the pipeline will be successful, but stage 2 will show as failed:

Pipeline Example

As you might have guessed, you can freely choose the buildResult and stageResult, in case you want it to be unstable or anything else. You can even fail the build and continue the execution of the pipeline.

Just make sure your Jenkins is up to date, since this feature is only available since "Pipeline: Basic Steps" 2.16 (May 14, 2019). Before that, catchError is still available but without parameters:

        steps {             catchError {                 sh "exit 1"             }         } 
like image 35
Erik B Avatar answered Sep 24 '22 10:09

Erik B


I was looking for an answer for a long time and I found a hack for it! I put the try/catch block on the whole stage:

 try {
   stage('some-stage') {
         //do something
   }
 } catch (Exception e) {
    echo "Stage failed, but we continue"  
 }
 try {
   stage("some-other-stage") {  // do something }
 } catch (Exception e) {
    echo "Stage failed, but we still continue"
 }

As result you will get something like this: enter image description here

This is still not ideal, but it gives the necessary results.

like image 35
Stacy Avatar answered Sep 25 '22 10:09

Stacy


In recent versions it's possible to pass propogate=false option to build step.

link: https://jenkins.io/doc/pipeline/steps/pipeline-build-step/

example: build job:"jobName", propagate:false

like image 33
Vano Avatar answered Sep 26 '22 10:09

Vano