Unlocking Advanced Logic in Declarative Jenkins Pipelines with Callbacks and Conditional Steps

8 August 2024

Introducing Declarative Jenkins Pipelines

Declarative Jenkins Pipelines are a game-changer for CI/CD workflows, offering a simpler, more readable way to define build processes. By using a YAML syntax, developers can easily create complex pipelines without getting lost in the complexity of scripted flows.

Callbacks in Declarative Jenkins Pipelines

One of the key features of Declarative Pipelines is the ability to use callbacks. A callback is essentially a function that can be called from within another function. In the context of Declarative Pipelines, callbacks allow you to execute custom code at specific points during the pipeline execution.

pipeline {
    agent any
    options {
        timeout time: 10, unit: 'MINUTES'
    }
    stages {
        stage('Build') {
            steps {
                sh 'mvn clean package'
            }
        }
        stage('Test') {
            steps {
                callback {
                    // Custom code to be executed here
                }
            }
        }
    }
}

In the above example, a callback is defined within the Test stage. This callback can contain custom code that will be executed at the specified point in the pipeline.

Conditional Steps in Declarative Jenkins Pipelines

Conditional steps are another powerful feature of Declarative Pipelines. They allow you to execute specific stages or steps based on certain conditions. This is achieved using the when directive, which can take a variety of inputs, including boolean expressions, environment variables, and more.

pipeline {
    agent any
    options {
        timeout time: 10, unit: 'MINUTES'
    }
    stages {
        stage('Build') {
            steps {
                sh 'mvn clean package'
            }
        }
        stage('Test') {
            when {
                environment name: 'IS_WINDOWS', value: 'true'
            }
            steps {
                sh 'run-windows-tests.sh'
            }
        }
        stage('Deploy') {
            when {
                environment name: 'IS_LINUX', value: 'true'
            }
            steps {
                sh 'deploy-to-linux.sh'
            }
        }
    }
}

In this example, the Test and Deploy stages are conditional on the presence of specific environment variables. If these conditions are met, the corresponding stage will be executed.

Conclusion

Declarative Jenkins Pipelines offer a flexible and readable way to define complex CI/CD workflows. By leveraging callbacks and conditional steps, you can unlock advanced logic in your pipelines and make them more efficient and effective. Whether you’re building software or deploying infrastructure, Declarative Pipelines are an essential tool for any modern developer or sysadmin.

Poespas Blog