Conditional deployment logic in Jenkins - Step-by-Step Execution

Process Flow - Conditional deployment logic

Start Pipeline

↓

Check Condition

↓

Deploy

↓

End Pipeline

The pipeline starts, checks a condition, then either deploys if true or skips deployment if false, then ends.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Deploy') {
      when { branch 'main' }
      steps { echo 'Deploying...' }
    }
  }
}

This Jenkins pipeline deploys only if the branch is 'main'.

Process Table

Step	Condition Checked	Condition Result	Action Taken	Output
1	Is branch 'main'?	True	Execute deploy stage	Deploying...
2	Pipeline ends	-	Finish	Pipeline completed successfully

💡 Pipeline ends after deployment stage completes because condition was true.

Status Tracker

Variable	Start	After Step 1	After Step 2
branch	main	main	main
deploy_stage_executed	false	true	true

Key Moments - 2 Insights

Why does the deploy stage run only when the branch is 'main'?

Because the 'when' condition checks the branch name. In the execution table row 1, the condition is true only if branch equals 'main', triggering deployment.

What happens if the branch is not 'main'?

The deploy stage is skipped. The condition in row 1 would be false, so no deploy action occurs and pipeline ends without deployment.

Visual Quiz - 3 Questions

Look at the execution table, what is the output at step 1?

A Skipping deployment

B Pipeline failed

C Deploying...

D No output

💡 Hint

Check the 'Output' column in execution_table row 1.

At which step does the pipeline finish?

A Step 1

B Step 2

C Before Step 1

D After Step 3

💡 Hint

Look at the 'Action Taken' column for pipeline completion.

If the branch was 'feature', what would happen to 'deploy_stage_executed' variable?

A It would remain false

B It would be undefined

C It would be true

D It would cause an error

💡 Hint

Refer to variable_tracker and key_moments about condition false case.

Concept Snapshot

Jenkins conditional deployment uses 'when' to check conditions.
If condition true, deploy stage runs.
If false, stage is skipped.
Common use: deploy only on 'main' branch.
Helps avoid unwanted deployments.

Full Transcript

This Jenkins pipeline example shows conditional deployment logic. The pipeline starts and checks if the current branch is 'main'. If yes, it runs the deploy stage and prints 'Deploying...'. If not, it skips deployment. The execution table traces these steps clearly. Variables track the branch name and whether deployment ran. Key moments clarify why deployment depends on the branch and what happens if the condition is false. The visual quiz tests understanding of outputs and variable states. The snapshot summarizes how Jenkins uses 'when' conditions to control deployment stages.

Practice

1. What is the main purpose of using a when block in a Jenkins pipeline?

easy

A. To define environment variables for the pipeline

B. To run a stage only if certain conditions are met

C. To specify the agent where the pipeline runs

D. To declare pipeline parameters

Solution

1. Step 1: Understand the role of when in Jenkins

   The when block controls whether a stage runs based on conditions.

2. Step 2: Compare options with when usage

   Only To run a stage only if certain conditions are met describes conditional execution, which matches when functionality.

3. Final Answer:

   To run a stage only if certain conditions are met -> Option B

4. Quick Check:

   when controls stage execution = A [OK]

Hint: Remember: when means "only if" for stages [OK]

Common Mistakes:

• Confusing when with environment setup
• Thinking when sets agents
• Assuming when declares parameters

2. Which of the following is the correct syntax to run a stage only on the 'main' branch in a declarative Jenkins pipeline?

easy

A. when { branch is 'main' }

B. when { branch == 'main' }

C. when { branch 'main' }

D. when { branch equals 'main' }

Solution

1. Step 1: Recall correct when syntax for branch condition

   The correct syntax uses branch 'main' inside when block.

2. Step 2: Check each option's syntax

   Only when { branch 'main' } matches Jenkins declarative syntax; others use invalid expressions.

3. Final Answer:

   when { branch 'main' } -> Option C

4. Quick Check:

   Correct branch syntax = C [OK]

Hint: Use branch 'name' exactly inside when [OK]

Common Mistakes:

• Using comparison operators inside when
• Writing invalid expressions like 'branch =='
• Confusing Groovy syntax with declarative syntax

3. Given this Jenkins pipeline snippet, what will happen if the branch is 'develop'?

stage('Deploy') {
  when {
    branch 'main'
  }
  steps {
    echo 'Deploying to production'
  }
}

medium

A. The stage will be skipped and nothing prints

B. The stage will run and print 'Deploying to production'

C. The pipeline will fail with a syntax error

D. The stage will run but print nothing

Solution

1. Step 1: Analyze the when condition

   The stage runs only if branch is 'main'. Here branch is 'develop', so condition fails.

2. Step 2: Determine stage behavior on condition failure

   When when condition fails, the stage is skipped and no steps run.

3. Final Answer:

   The stage will be skipped and nothing prints -> Option A

4. Quick Check:

   Branch mismatch skips stage = A [OK]

Hint: If branch doesn't match when, stage skips silently [OK]

Common Mistakes:

• Assuming stage runs anyway
• Expecting error on branch mismatch
• Thinking stage runs but prints nothing

4. Identify the error in this Jenkins pipeline snippet that tries to deploy only if environment variable DEPLOY is 'true':

stage('Deploy') {
  when {
    environment DEPLOY == 'true'
  }
  steps {
    echo 'Deploying application'
  }
}

medium

A. The stage name cannot be 'Deploy'

B. The when block must be inside steps

C. The echo command is not allowed in steps

D. The environment condition is invalid syntax

Solution

1. Step 1: Check when syntax for environment variable

   The correct syntax uses environment name: 'DEPLOY', value: 'true' or expression blocks, not direct comparison.

2. Step 2: Identify invalid usage

   Using environment DEPLOY == 'true' is invalid and causes syntax error.

3. Final Answer:

   The environment condition is invalid syntax -> Option D

4. Quick Check:

   Invalid environment condition syntax = D [OK]

Hint: Use correct when { environment name: 'VAR', value: 'val' } syntax [OK]

Common Mistakes:

• Writing direct comparisons inside when
• Placing when inside steps
• Misusing stage names

5. You want to deploy only if the branch is 'release' and the environment variable DEPLOY is 'yes'. Which when block correctly implements this in a declarative Jenkins pipeline?

hard

A. when { allOf { branch 'release'; environment name: 'DEPLOY', value: 'yes' } }

B. when { branch 'release' && environment DEPLOY == 'yes' }

C. when { branch 'release' environment DEPLOY == 'yes' }

D. when { anyOf { branch 'release'; environment name: 'DEPLOY', value: 'yes' } }

Solution

1. Step 1: Understand combining conditions in when

   Use allOf to require both conditions true simultaneously.

2. Step 2: Check syntax for branch and environment conditions

   when { allOf { branch 'release'; environment name: 'DEPLOY', value: 'yes' } } correctly uses allOf with branch 'release' and environment name: 'DEPLOY', value: 'yes'.

3. Step 3: Identify errors in other options

   Options A and C use invalid syntax; D uses anyOf which means either condition, not both.

4. Final Answer:

   when { allOf { branch 'release'; environment name: 'DEPLOY', value: 'yes' } } -> Option A

5. Quick Check:

   Use allOf for AND conditions = B [OK]

Hint: Use allOf to combine multiple when conditions [OK]

Common Mistakes:

• Using anyOf instead of allOf
• Writing invalid combined expressions
• Misusing environment condition syntax