Pipeline linting and validation in Jenkins - Mini Project: Build & Apply

Pipeline linting and validation

📖 Scenario: You are a DevOps engineer working on a Jenkins pipeline for a software project. Before running the pipeline, you want to check if the pipeline script is valid and free of syntax errors. This helps avoid pipeline failures and saves time.

🎯 Goal: Build a simple Jenkins pipeline script and use Jenkins pipeline linting and validation commands to check its correctness before execution.

📋 What You'll Learn

Create a basic Jenkins pipeline script with a single stage

Add a configuration variable for the pipeline agent

Use the Jenkins CLI or REST API to lint and validate the pipeline script

Print the validation result to confirm the pipeline is valid

💡 Why This Matters

🌍 Real World

Pipeline linting helps catch syntax errors before running Jenkins pipelines, saving time and preventing build failures.

💼 Career

DevOps engineers and Jenkins administrators use pipeline validation to maintain reliable and error-free automation workflows.

1

Create a basic Jenkins pipeline script

Create a Jenkins pipeline script variable called pipeline_script with this exact content: pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } }

Jenkins

# Create a variable called pipeline_script with the exact Jenkins pipeline script string
# Your code here

Need a hint?

Use a string variable named pipeline_script and assign the full pipeline script as a single string.

2

Add a configuration variable for the pipeline agent

Create a variable called agent_type and set it to the string 'any' to specify the Jenkins pipeline agent.

Jenkins

pipeline_script = "pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } }"
# Create a variable called agent_type and set it to 'any'
# Your code here

Need a hint?

Just assign the string 'any' to a variable named agent_type.

3

Use Jenkins CLI to lint and validate the pipeline script

Write a command string variable called lint_command that uses Jenkins CLI to lint the pipeline script stored in pipeline_script. The command should be: java -jar jenkins-cli.jar -s http://localhost:8080/ declarative-linter and the pipeline script should be passed via standard input.

Jenkins

pipeline_script = "pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } }"
agent_type = 'any'
# Create a variable lint_command with the Jenkins CLI lint command string
# Your code here

Need a hint?

Assign the exact Jenkins CLI lint command string to lint_command.

4

Print the validation result

Print the exact string Pipeline script is valid to confirm the pipeline script passed linting.

Jenkins

pipeline_script = "pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } }"
agent_type = 'any'
lint_command = "java -jar jenkins-cli.jar -s http://localhost:8080/ declarative-linter"
# Print the validation success message
# Your code here

Need a hint?

Use print("Pipeline script is valid") to show the success message.