Parameterized builds in Jenkins - Mini Project: Build & Apply

Parameterized Builds in Jenkins

📖 Scenario: You are a DevOps engineer setting up a Jenkins job that can build different versions of a software project based on user input. This helps your team quickly test or deploy specific versions without changing the job configuration each time.

🎯 Goal: Create a Jenkins pipeline script that accepts a parameter for the software version, uses it in the build steps, and prints the selected version.

📋 What You'll Learn

Create a string parameter called VERSION with default value 1.0

Use the VERSION parameter in a shell build step

Print the selected VERSION value at the end

💡 Why This Matters

🌍 Real World

Parameterized builds let teams run the same Jenkins job with different inputs, saving time and reducing errors.

💼 Career

Knowing how to create and use parameters in Jenkins pipelines is a key skill for DevOps engineers and automation specialists.

1

Define the Jenkins pipeline with a VERSION parameter

Create a Jenkins pipeline script that defines a string parameter called VERSION with the default value 1.0. Use the parameters block to do this.

Jenkins

pipeline {
    agent any
    parameters {
        // Define the VERSION parameter here
    }
    stages {
        stage('Build') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use the parameters block inside the pipeline and add a string parameter with the name VERSION.

2

Add a shell step that uses the VERSION parameter

Inside the Build stage's steps block, add a shell command that echoes Building version: ${VERSION} using the Jenkins parameter VERSION.

Jenkins

pipeline {
    agent any
    parameters {
        string(name: 'VERSION', defaultValue: '1.0', description: 'Software version to build')
    }
    stages {
        stage('Build') {
            steps {
                // Add shell command to echo the VERSION parameter
            }
        }
    }
}

Hint

Use the sh step with a command that prints the VERSION parameter value.

3

Add a stage to print the selected VERSION

Add a new stage called Print Version after the Build stage. Inside its steps block, add a shell command that prints Selected version is: ${VERSION}.

Jenkins

pipeline {
    agent any
    parameters {
        string(name: 'VERSION', defaultValue: '1.0', description: 'Software version to build')
    }
    stages {
        stage('Build') {
            steps {
                sh 'echo Building version: ${VERSION}'
            }
        }
        // Add the Print Version stage here
    }
}

Hint

Add a new stage block with the name Print Version and inside it add a sh step to print the version.

4

Run the pipeline and verify the output

Run the Jenkins pipeline script. The output should include the lines Building version: 1.0 and Selected version is: 1.0 when using the default parameter.

Jenkins

pipeline {
    agent any
    parameters {
        string(name: 'VERSION', defaultValue: '1.0', description: 'Software version to build')
    }
    stages {
        stage('Build') {
            steps {
                sh 'echo Building version: ${VERSION}'
            }
        }
        stage('Print Version') {
            steps {
                sh 'echo Selected version is: ${VERSION}'
            }
        }
    }
}

// Run the pipeline and check output

Hint

Run the pipeline with default parameters and check the console output for the expected lines.

Practice

1.

What is the main purpose of parameterized builds in Jenkins?

easy

A. To allow users to input values that customize the build process

B. To automatically deploy builds to production

C. To schedule builds at specific times

D. To monitor server health during builds

Solution

1. Step 1: Understand parameterized builds concept

   Parameterized builds let users provide inputs that change how the build runs.

2. Step 2: Identify the main purpose

   The main goal is to customize the build without changing the job code.

3. Final Answer:

   To allow users to input values that customize the build process -> Option A

4. Quick Check:

   Parameterized builds = user inputs [OK]

Hint: Think: 'How do I change build behavior without editing code?' [OK]

Common Mistakes:

• Confusing parameterized builds with scheduling
• Thinking parameters deploy builds automatically
• Mixing monitoring with build customization

2.

Which of the following is the correct syntax to define a string parameter named ENV in a Jenkins pipeline?

parameters {
    ?
}

easy

A. paramString('ENV', 'dev', 'Environment')

B. string(name: 'ENV', defaultValue: 'dev', description: 'Environment')

C. stringParam('ENV', 'dev', 'Environment')

D. parameterString(name='ENV', default='dev')

Solution

1. Step 1: Recall Jenkins pipeline parameter syntax

   Jenkins uses string(name: '', defaultValue: '', description: '') inside parameters block.

2. Step 2: Match correct syntax

   string(name: 'ENV', defaultValue: 'dev', description: 'Environment') matches the correct syntax exactly.

3. Final Answer:

   string(name: 'ENV', defaultValue: 'dev', description: 'Environment') -> Option B

4. Quick Check:

   Correct parameter syntax = string(name: 'ENV', defaultValue: 'dev', description: 'Environment') [OK]

Hint: Remember: 'string' with named args inside parameters block [OK]

Common Mistakes:

• Using incorrect function names like stringParam
• Missing named arguments or using wrong argument names
• Confusing parameter syntax with freestyle job parameters

3.

Given this Jenkins pipeline snippet, what will be printed if the build is started with parameter BRANCH=feature?

pipeline {
  agent any
  parameters {
    string(name: 'BRANCH', defaultValue: 'main', description: 'Git branch')
  }
  stages {
    stage('Print Branch') {
      steps {
        echo "Building branch: ${params.BRANCH}"
      }
    }
  }
}

medium

A. Building branch: main

B. Error: BRANCH parameter not found

C. Building branch: feature

D. Building branch: ${params.BRANCH}

Solution

1. Step 1: Understand parameter usage in pipeline

   The parameter BRANCH has default 'main' but can be overridden at build start.

2. Step 2: Check what happens when build starts with BRANCH=feature

   The value 'feature' replaces default, so params.BRANCH is 'feature'.

3. Final Answer:

   Building branch: feature -> Option C

4. Quick Check:

   Parameter override prints new value [OK]

Hint: Parameter value at build start overrides default [OK]

Common Mistakes:

• Assuming default value always prints
• Thinking variable is not replaced in echo
• Confusing parameter name with environment variables

4.

Identify the error in this Jenkins pipeline snippet that defines a boolean parameter:

pipeline {
  agent any
  parameters {
    booleanParam(name: 'DEPLOY', default: true, description: 'Deploy after build?')
  }
  stages {
    stage('Check Deploy') {
      steps {
        script {
          if (params.DEPLOY) {
            echo 'Deploying...'
          } else {
            echo 'Skipping deploy'
          }
        }
      }
    }
  }
}

medium

A. The 'script' block is not allowed inside 'steps'

B. The parameter name should be 'boolean' not 'booleanParam'

C. The if condition should use 'params.deploy' in lowercase

D. The default value key should be 'defaultValue' not 'default'

Solution

1. Step 1: Check boolean parameter syntax

   Jenkins expects booleanParam(name: '', defaultValue: true/false, description: '').

2. Step 2: Identify incorrect key

   The snippet uses default instead of defaultValue, causing syntax error.

3. Final Answer:

   The default value key should be 'defaultValue' not 'default' -> Option D

4. Quick Check:

   Boolean param uses defaultValue key [OK]

Hint: Use 'defaultValue' for parameters, not 'default' [OK]

Common Mistakes:

• Using 'default' instead of 'defaultValue'
• Wrong parameter type name
• Incorrect case in parameter usage

5.

You want to create a Jenkins pipeline that asks for two parameters: a choice of ENV with options dev, qa, prod, and a boolean RUN_TESTS. The pipeline should print the selected environment and whether tests will run. Which snippet correctly defines these parameters and uses them in the Print Info stage?

hard

A. parameters {
choice(name: 'ENV', choices: ['dev', 'qa', 'prod'], description: 'Select environment')
booleanParam(name: 'RUN_TESTS', defaultValue: false, description: 'Run tests?')
}
stages {
stage('Print Info') {
steps {
echo "Environment: ${params.ENV}"
echo "Run tests: ${params.RUN_TESTS}"
}
}
}

B. parameters {
choice(name: 'ENV', choices: 'dev,qa,prod', description: 'Select environment')
boolean(name: 'RUN_TESTS', defaultValue: false, description: 'Run tests?')
}
stages {
stage('Print Info') {
steps {
echo "Environment: ${ENV}"
echo "Run tests: ${RUN_TESTS}"
}
}
}

C. parameters {
choice(name: 'ENV', choices: ['dev', 'qa', 'prod'], description: 'Select environment')
booleanParam(name: 'RUN_TESTS', default: false, description: 'Run tests?')
}
stages {
stage('Print Info') {
steps {
echo "Environment: ${params.ENV}"
echo "Run tests: ${params.RUN_TESTS}"
}
}
}

D. parameters {
choice(name: 'ENV', choices: 'dev,qa,prod', description: 'Select environment')
booleanParam(name: 'RUN_TESTS', defaultValue: false, description: 'Run tests?')
}
stages {
stage('Print Info') {
steps {
echo "Environment: ${params.ENV}"
echo "Run tests: ${params.RUN_TESTS}"
}
}
}

Solution

1. Step 1: Verify parameter definitions

   Choice parameter requires choices as a list, boolean parameter uses booleanParam with defaultValue.

2. Step 2: Check parameter usage in steps

   Parameters must be accessed as params.ENV and params.RUN_TESTS inside echo.

3. Final Answer:

   parameters { choice(name: 'ENV', choices: ['dev', 'qa', 'prod'], description: 'Select environment') booleanParam(name: 'RUN_TESTS', defaultValue: false, description: 'Run tests?') } stages { stage('Print Info') { steps { echo "Environment: ${params.ENV}" echo "Run tests: ${params.RUN_TESTS}" } } } -> Option A

4. Quick Check:

   Correct parameter syntax + params usage = parameters { choice(name: 'ENV', choices: ['dev', 'qa', 'prod'], description: 'Select environment') booleanParam(name: 'RUN_TESTS', defaultValue: false, description: 'Run tests?') } stages { stage('Print Info') { steps { echo "Environment: ${params.ENV}" echo "Run tests: ${params.RUN_TESTS}" } } } [OK]

Hint: Use list for choices and 'params.' prefix to access parameters [OK]

Common Mistakes:

• Passing choices as comma string instead of list
• Using 'default' instead of 'defaultValue' for booleanParam
• Accessing parameters without 'params.' prefix