Why When to use scripted over declarative in Jenkins? - Purpose & Use Cases

The Big Idea

What if your pipeline could think and decide exactly what to do next, like a smart assistant?

The Scenario

Imagine you have a complex project with many unique steps and conditions. You try to write your Jenkins pipeline by manually scripting every detail without a clear structure.

The Problem

This manual scripting becomes confusing and hard to maintain. Small changes break the flow, and it's easy to make mistakes that stop your builds.

The Solution

Using scripted pipelines in Jenkins lets you write flexible, step-by-step code that handles complex logic clearly. It gives you full control to customize your build process exactly how you want.

Before vs After

✗ Before

pipeline {
  stages {
    stage('Build') {
      steps {
        echo 'Building...'
      }
    }
  }
}

✓ After

node {
  stage('Build') {
    echo 'Building...'
  }
  if (env.BRANCH_NAME == 'main') {
    stage('Deploy') {
      echo 'Deploying to production'
    }
  }
}

What It Enables

Scripted pipelines enable you to handle complex workflows and custom logic that declarative pipelines can't easily express.

Real Life Example

A team needs to run different tests and deploy steps depending on many conditions like branch name, environment variables, or external approvals. Scripted pipelines let them write this logic clearly and flexibly.

Key Takeaways

Manual scripting without structure is error-prone and hard to maintain.

Scripted pipelines give full control for complex, custom workflows.

Use scripted when your build needs logic that declarative can't handle easily.

Practice

1. Which situation is best suited for using a scripted Jenkins pipeline instead of a declarative one?

easy

A. When you want to use built-in syntax for parallel stages only

B. When you want a simple, easy-to-read pipeline with fixed stages

C. When you need complex loops and conditional logic that declarative can't handle

D. When you want to avoid writing any Groovy code

Solution

1. Step 1: Understand pipeline types

   Declarative pipelines are simpler and use a fixed syntax, while scripted pipelines allow full Groovy code control.

2. Step 2: Match use case to pipeline type

   Complex loops and dynamic conditions require scripted pipelines because declarative syntax is limited.

3. Final Answer:

   When you need complex loops and conditional logic that declarative can't handle -> Option C

4. Quick Check:

   Complex logic = scripted [OK]

Hint: Choose scripted for complex logic, declarative for simple flow [OK]

Common Mistakes:

• Thinking declarative supports all Groovy features
• Using scripted for simple pipelines unnecessarily
• Confusing parallel stage support as exclusive to scripted

2. Which of the following is the correct way to start a scripted pipeline in Jenkins?

easy

A. node { stage('Build') { echo 'Hello' } }

B. pipeline { agent any; stages { stage('Build') { steps { echo 'Hello' } } } }

C. stages { stage('Build') { steps { echo 'Hello' } } }

D. build { stage('Build') { echo 'Hello' } }

Solution

1. Step 1: Identify scripted pipeline syntax

   Scripted pipelines use Groovy code inside a node block, not the pipeline block.

2. Step 2: Check each option

   node { stage('Build') { echo 'Hello' } } uses node { stage('Build') { echo 'Hello' } } which is correct scripted syntax.

3. Final Answer:

   node { stage('Build') { echo 'Hello' } } -> Option A

4. Quick Check:

   Scripted pipelines start with node block [OK]

Hint: Scripted pipelines start with node block, declarative with pipeline [OK]

Common Mistakes:

• Using declarative pipeline syntax for scripted pipelines
• Omitting the node block in scripted pipelines
• Confusing stages block as scripted syntax

3. What will be the output of this scripted pipeline snippet?

node {
  for (int i = 1; i <= 3; i++) {
    echo "Count: ${i}"
  }
}

medium

A. Count: 1\nCount: 2\nCount: 3

B. Count: 3

C. Syntax error due to for loop

D. No output because echo is invalid here

Solution

1. Step 1: Understand scripted pipeline loop

   The for loop runs from 1 to 3, printing each count with echo.

2. Step 2: Predict output

   Each iteration prints "Count: 1", "Count: 2", and "Count: 3" on separate lines.

3. Final Answer:

   Count: 1\nCount: 2\nCount: 3 -> Option A

4. Quick Check:

   Loop prints each count line [OK]

Hint: For loops in scripted pipelines print each iteration output [OK]

Common Mistakes:

• Assuming only last iteration prints
• Thinking for loop syntax is invalid in scripted
• Believing echo cannot be used inside node

4. Identify the error in this scripted pipeline snippet:

node {
  stage('Build') {
    echo 'Building...'
  }
  stage('Test')
    echo 'Testing...'
}

medium

A. stage keyword cannot be used in scripted pipelines

B. Incorrect use of echo command inside node

C. node block must be inside stage blocks

D. Missing braces {} around the 'Test' stage block

Solution

1. Step 1: Check stage syntax in scripted pipeline

   Each stage block must have braces {} to group its commands.

2. Step 2: Identify missing braces

   The 'Test' stage lacks braces around echo, causing syntax error.

3. Final Answer:

   Missing braces {} around the 'Test' stage block -> Option D

4. Quick Check:

   All stage blocks need braces in scripted [OK]

Hint: Always use braces {} for stage blocks in scripted pipelines [OK]

Common Mistakes:

• Omitting braces for single commands in stages
• Thinking stage keyword is invalid in scripted
• Misplacing node and stage blocks

5. You want to create a Jenkins pipeline that dynamically creates stages based on a list of environments (dev, test, prod). Which pipeline type should you use and why?

hard

A. Declarative pipeline, because it supports dynamic stage creation easily

B. Scripted pipeline, because it allows loops and dynamic stage generation with Groovy

C. Declarative pipeline, because scripted pipelines cannot handle multiple stages

D. Neither, Jenkins does not support dynamic stages

Solution

1. Step 1: Understand dynamic stage requirements

   Creating stages dynamically requires looping and conditional logic.

2. Step 2: Match pipeline type to dynamic behavior

   Scripted pipelines allow Groovy loops to generate stages dynamically; declarative pipelines are static.

3. Final Answer:

   Scripted pipeline, because it allows loops and dynamic stage generation with Groovy -> Option B

4. Quick Check:

   Dynamic stages = scripted pipeline [OK]

Hint: Use scripted pipelines for dynamic or complex stage creation [OK]

Common Mistakes:

• Assuming declarative supports dynamic stages easily
• Believing scripted pipelines cannot handle multiple stages
• Thinking Jenkins disallows dynamic pipeline structures