Pipeline visualization and debugging in Jenkins - Mini Project: Build & Apply

Pipeline visualization and debugging

📖 Scenario: You are a DevOps engineer working with Jenkins pipelines to automate software builds and tests. You want to create a simple pipeline script that shows how to visualize the pipeline stages and debug by printing messages at each step.

🎯 Goal: Build a Jenkins pipeline script with multiple stages, add a configuration variable to control debug output, and print debug messages to visualize the pipeline execution.

📋 What You'll Learn

Create a Jenkins pipeline script with three stages: Build, Test, and Deploy

Add a boolean variable debug to control debug message printing

Use if condition to print debug messages only when debug is true

Print a final message indicating pipeline completion

💡 Why This Matters

🌍 Real World

Jenkins pipelines automate software build, test, and deployment processes. Visualizing pipeline stages and debugging with messages helps engineers understand and fix issues quickly.

💼 Career

DevOps engineers and automation specialists use pipeline visualization and debugging to maintain reliable CI/CD workflows and ensure smooth software delivery.

1

Create the initial Jenkins pipeline with stages

Write a Jenkins pipeline script using pipeline and stages blocks. Create three stages named Build, Test, and Deploy. Inside each stage, add a steps block with a echo command that prints the stage name, for example, echo 'Building...' in the Build stage.

Jenkins

pipeline {
    agent any
    stages {
        // Your code here
    }
}

Need a hint?

Use pipeline and stages blocks. Each stage needs a steps block with an echo command.

2

Add a debug configuration variable

Add a boolean variable called debug at the top level inside the pipeline block, before stages. Set debug to true to enable debug messages.

Jenkins

pipeline {
    agent any
    // Your code here
    stages {
        stage('Build') {
            steps {
                echo 'Building...'
            }
        }
        stage('Test') {
            steps {
                echo 'Testing...'
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying...'
            }
        }
    }
}

Need a hint?

Declare a boolean variable using the environment block inside the pipeline block but before stages. Use DEBUG = 'true' as environment variable.

3

Add debug messages inside each stage

Inside each stage's steps block, add an if condition that checks if debug is true. If true, print a debug message using echo like echo 'Debug: Starting Build stage' in the Build stage. Keep the original stage message as well.

Jenkins

pipeline {
    agent any
    environment {
        DEBUG = 'true'
    }
    stages {
        stage('Build') {
            steps {
                // Your code here
            }
        }
        stage('Test') {
            steps {
                // Your code here
            }
        }
        stage('Deploy') {
            steps {
                // Your code here
            }
        }
    }
}

Need a hint?

Use script { if (env.DEBUG == 'true') { echo 'Debug: ...' } } inside each stage's steps block before the main echo.

4

Print a final pipeline completion message

Add a post block at the end of the pipeline that runs always. Inside it, add a steps block with echo 'Pipeline completed successfully.' to print a final message after all stages finish.

Jenkins

pipeline {
    agent any
    environment {
        DEBUG = 'true'
    }
    stages {
        stage('Build') {
            steps {
                script {
                    if (env.DEBUG == 'true') {
                        echo 'Debug: Starting Build stage'
                    }
                }
                echo 'Building...'
            }
        }
        stage('Test') {
            steps {
                script {
                    if (env.DEBUG == 'true') {
                        echo 'Debug: Starting Test stage'
                    }
                }
                echo 'Testing...'
            }
        }
        stage('Deploy') {
            steps {
                script {
                    if (env.DEBUG == 'true') {
                        echo 'Debug: Starting Deploy stage'
                    }
                }
                echo 'Deploying...'
            }
        }
    }
    // Your code here
}

Need a hint?

Use a post { always { steps { echo ... } } } block after stages.