Webhook triggers from GitHub/GitLab in Jenkins - Mini Project: Build & Apply

Webhook triggers from GitHub/GitLab

📖 Scenario: You want to automate your Jenkins build process so that it starts automatically whenever you push code to your GitHub or GitLab repository. This saves time and avoids manual build triggers.

🎯 Goal: Set up a Jenkins pipeline that triggers automatically using webhooks from GitHub or GitLab.

📋 What You'll Learn

Create a Jenkins pipeline job with a basic Jenkinsfile

Add a configuration variable to enable webhook triggers

Configure the pipeline to listen for webhook events

Print a message when the webhook trigger starts the build

💡 Why This Matters

🌍 Real World

Automating builds on code push saves time and reduces errors by removing manual build starts.

💼 Career

Understanding webhook triggers is essential for DevOps engineers to integrate CI/CD pipelines with source control systems like GitHub and GitLab.

1

Create a basic Jenkins pipeline

Create a Jenkinsfile with a pipeline block that has an agent any and a stage named Build that runs a simple echo command printing "Starting build...".

Jenkins

# Create a Jenkinsfile with a pipeline block
# Your code here

Need a hint?

Use pipeline { agent any stages { stage('Build') { steps { echo "Starting build..." } } } }

2

Add webhook trigger configuration

Add a triggers block inside the pipeline that uses GenericTrigger to enable webhook triggers from GitHub or GitLab.

Jenkins

pipeline {
    agent any
    // Add triggers block here
    stages {
        stage('Build') {
            steps {
                echo "Starting build..."
            }
        }
    }
}
# Your code here

Need a hint?

Inside pipeline {}, add triggers { GenericTrigger() } to enable webhook triggers.

3

Configure webhook event handling

Inside the GenericTrigger(), add a genericVariables block with a variable named ref that extracts the branch name from the webhook payload using $.ref. Also add a causeString describing the trigger as "Triggered by Git webhook".

Jenkins

pipeline {
    agent any
    triggers {
        GenericTrigger(
            // Add genericVariables and causeString here
        )
    }
    stages {
        stage('Build') {
            steps {
                echo "Starting build..."
            }
        }
    }
}
# Your code here

Need a hint?

Use GenericTrigger(genericVariables: [[key: 'ref', value: '$.ref']], causeString: 'Triggered by Git webhook') inside triggers {}.

4

Print webhook trigger details

Inside the Build stage's steps, add an echo command that prints "Build triggered on branch: ${ref}" to show which branch triggered the build.

Jenkins

pipeline {
    agent any
    triggers {
        GenericTrigger(
            genericVariables: [
                [key: 'ref', value: '$.ref']
            ],
            causeString: 'Triggered by Git webhook'
        )
    }
    stages {
        stage('Build') {
            steps {
                echo "Starting build..."
                # Add echo to print branch name here
            }
        }
    }
}
# Your code here

Need a hint?

Use echo "Build triggered on branch: ${ref}" inside the steps block.