Parameterized builds in Jenkins - Step-by-Step Execution

Process Flow - Parameterized builds

Start Build

↓

Prompt for Parameters

↓

User Inputs Values

↓

Build Uses Parameters

↓

Build Executes with Inputs

↓

Build Completes with Results

The build starts by asking for input parameters, then uses those inputs during the build execution, and finally completes with results based on those inputs.

Execution Sample

Jenkins

pipeline {
  agent any
  parameters {
    string(name: 'GREETING', defaultValue: 'Hello', description: 'Greeting message')
  }
  stages {
    stage('Say Hello') {
      steps {
        echo "${params.GREETING}, Jenkins!"
      }
    }
  }
}

This Jenkins pipeline asks for a greeting message and then prints it during the build.

Process Table

Step	Action	Parameter Value	Build Output
1	Build starts and prompts for GREETING	No value yet	Waiting for input
2	User inputs GREETING='Hi there'	Hi there	Ready to run build
3	Build runs stage 'Say Hello'	Hi there	Prints: Hi there, Jenkins!
4	Build completes	Hi there	Build success

💡 Build finishes after using the parameter value in the echo step

Status Tracker

Variable	Start	After Step 2	After Step 3	Final
params.GREETING	undefined	Hi there	Hi there	Hi there

Key Moments - 2 Insights

Why does the build ask for GREETING before running?

Because the parameter is defined in the 'parameters' block, Jenkins pauses to get user input before executing the build steps, as shown in execution_table step 1 and 2.

What happens if no input is given for GREETING?

The build uses the default value 'Hello' defined in the parameter, so the output would be 'Hello, Jenkins!' instead of a user input, as implied by the defaultValue in the code.

Visual Quiz - 3 Questions

Look at the execution table, what is the parameter value at step 3?

A "Hello"

B undefined

C "Hi there"

D null

💡 Hint

Check the 'Parameter Value' column at step 3 in the execution_table

At which step does the build print the greeting message?

A Step 1

B Step 3

C Step 2

D Step 4

💡 Hint

Look at the 'Build Output' column to find when the message is printed

If the user inputs no value, what will the build output be?

A "Hello, Jenkins!"

B "Hi there, Jenkins!"

C ", Jenkins!"

D Build fails

💡 Hint

Refer to the defaultValue in the parameters block in the execution_sample code

Concept Snapshot

Jenkins Parameterized Builds:
- Define parameters in 'parameters' block
- Jenkins prompts user before build starts
- Use parameters via 'params.PARAM_NAME'
- Default values used if no input given
- Enables flexible, reusable builds

Full Transcript

Parameterized builds in Jenkins let you ask users for input before running a build. You define parameters in the pipeline code, like a string parameter named GREETING with a default value. When the build starts, Jenkins pauses and asks for the GREETING value. The user types a message, for example 'Hi there'. The build then uses this input in its steps, printing the greeting message. If the user does not provide input, the default value is used. This makes builds flexible and customizable without changing code.

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