WithCredentials block usage in Jenkins - Mini Project: Build & Apply

Using the WithCredentials Block in Jenkins Pipelines

📖 Scenario: You are setting up a Jenkins pipeline to deploy an application. The deployment requires a secret username and password stored securely in Jenkins credentials.To keep your secrets safe, you will use the withCredentials block in your Jenkins pipeline script.

🎯 Goal: Build a Jenkins pipeline script that uses the withCredentials block to access a username and password stored in Jenkins credentials, and then prints a message using those credentials.

📋 What You'll Learn

Create a Jenkins pipeline script with a pipeline block

Use withCredentials block to access credentials with ID my-credentials-id

Bind the username to variable USERNAME and password to variable PASSWORD

Inside the withCredentials block, print a message using echo that shows the username and a masked password

Use declarative pipeline syntax

💡 Why This Matters

🌍 Real World

In real Jenkins pipelines, you often need to use sensitive data like passwords or API keys. The withCredentials block helps you use these secrets safely without exposing them in logs.

💼 Career

Knowing how to use withCredentials is essential for DevOps engineers and anyone managing CI/CD pipelines to keep secrets secure and automate deployments.

1

Create the basic Jenkins pipeline structure

Write a Jenkins declarative pipeline script with a pipeline block and an empty stages section.

Jenkins

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

Need a hint?

Start with pipeline {, add agent any, and an empty stages block.

2

Add a stage named 'Deploy' with a steps block

Inside the stages block, add a stage named Deploy with an empty steps block.

Jenkins

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                // Your code here
            }
        }
    }
}

Need a hint?

Add stage('Deploy') and inside it add steps { }.

3

Use withCredentials block to bind username and password

Inside the steps block of the Deploy stage, add a withCredentials block that binds the Jenkins credentials with ID my-credentials-id to variables USERNAME and PASSWORD using usernamePassword binding.

Jenkins

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                withCredentials([usernamePassword(credentialsId: 'my-credentials-id', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) {
                    // Your code here
                }
            }
        }
    }
}

Need a hint?

Use withCredentials with usernamePassword binding and the exact credential ID and variable names.

4

Print a message using the credentials inside withCredentials block

Inside the withCredentials block, add an echo statement that prints: "Deploying with user: ${USERNAME} and password: ${PASSWORD}".

Jenkins

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                withCredentials([usernamePassword(credentialsId: 'my-credentials-id', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) {
                    // Your code here
                }
            }
        }
    }
}

Need a hint?

Use echo inside the withCredentials block to print the username and password variables.