Scripted vs declarative comparison in Jenkins - When to Use Which

The Big Idea

Discover how choosing the right pipeline style can save hours of frustration and keep your software flowing smoothly!

The Scenario

Imagine you have to write a long list of instructions for your team to build and test software, and every time something changes, you rewrite the whole list by hand.

The Problem

This manual way is slow and confusing. It's easy to make mistakes, forget steps, or write instructions that don't work well together. Fixing errors takes a lot of time and can cause delays.

The Solution

Using scripted or declarative pipelines in Jenkins lets you write your build and test steps clearly and safely. Declarative pipelines give you a simple, structured way to describe your process, while scripted pipelines offer more flexibility when needed.

Before vs After

✗ Before

node {
  stage('Build') {
    // manual shell commands
  }
  stage('Test') {
    // manual shell commands
  }
}

✓ After

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        // build commands
      }
    }
    stage('Test') {
      steps {
        // test commands
      }
    }
  }
}

What It Enables

You can quickly create reliable, repeatable pipelines that anyone can understand and update without fear.

Real Life Example

A team uses declarative pipelines to automate testing and deployment, so their app updates reach users faster and with fewer bugs.

Key Takeaways

Manual scripts are hard to maintain and error-prone.

Declarative pipelines provide clear, easy-to-read structure.

Scripted pipelines offer flexibility for complex needs.

Practice

1. Which statement best describes the main difference between scripted and declarative Jenkins pipelines?

easy

A. Scripted pipelines use Groovy code and are flexible; declarative pipelines have a fixed structure and are easier to read.

B. Declarative pipelines use Groovy code and are flexible; scripted pipelines have a fixed structure and are easier to read.

C. Both scripted and declarative pipelines have the same syntax and flexibility.

D. Scripted pipelines are only for building Java projects; declarative pipelines are for all other projects.

Solution

1. Step 1: Understand scripted pipeline nature

   Scripted pipelines use Groovy code, allowing more flexibility but requiring more coding skill.

2. Step 2: Understand declarative pipeline nature

   Declarative pipelines have a fixed, simpler structure designed for easier writing and reading.

3. Final Answer:

   Scripted pipelines use Groovy code and are flexible; declarative pipelines have a fixed structure and are easier to read. -> Option A

4. Quick Check:

   Scripted = flexible Groovy, Declarative = fixed structure [OK]

Hint: Remember: scripted = flexible code, declarative = fixed format [OK]

Common Mistakes:

• Confusing which pipeline uses Groovy code
• Thinking both pipelines have the same syntax
• Believing scripted pipelines are only for Java

2. Which of the following is the correct way to start a declarative Jenkins pipeline script?

easy

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

B. def build() { echo 'Building...' }

C. build { echo 'Building...' }

D. pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } }

Solution

1. Step 1: Identify declarative pipeline syntax

   Declarative pipelines start with the pipeline {} block and include agent and stages.

2. Step 2: Compare options

   pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } } correctly uses pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } } which matches declarative syntax.

3. Final Answer:

   pipeline { agent any; stages { stage('Build') { steps { echo 'Building...' } } } } -> Option D

4. Quick Check:

   Declarative starts with pipeline block [OK]

Hint: Declarative pipelines always start with 'pipeline { ... }' [OK]

Common Mistakes:

• Using scripted syntax for declarative pipelines
• Omitting the 'pipeline' block
• Missing 'stages' or 'steps' keywords

3. Given this scripted pipeline snippet, what will be the output?

node {
  stage('Test') {
    echo 'Running tests'
  }
}

medium

A. Prints 'Running tests' during the 'Test' stage

B. Syntax error because 'stage' is not allowed in scripted pipelines

C. No output because 'node' block is empty

D. Pipeline fails due to missing 'pipeline' block

Solution

1. Step 1: Analyze scripted pipeline structure

   The scripted pipeline uses node and stage blocks correctly with an echo step inside.

2. Step 2: Determine output

   The pipeline will run the 'Test' stage and print 'Running tests' to the console.

3. Final Answer:

   Prints 'Running tests' during the 'Test' stage -> Option A

4. Quick Check:

   Scripted pipelines allow stage and echo inside node [OK]

Hint: Scripted pipelines use node and stage blocks freely [OK]

Common Mistakes:

• Thinking 'stage' is only for declarative pipelines
• Expecting a syntax error without 'pipeline' block
• Assuming no output if node block is present

4. Identify the error in this declarative pipeline snippet:

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

medium

A. Incorrect use of 'pipeline' keyword

B. Missing 'agent' declaration

C. Missing 'steps' block inside the 'Build' stage

D. Using 'echo' instead of 'sh' command

Solution

1. Step 1: Review declarative pipeline stage structure

   Each stage must contain a steps block that holds the commands to run.

2. Step 2: Check the snippet

   The 'Build' stage directly contains echo without wrapping it inside steps {}, which is invalid.

3. Final Answer:

   Missing 'steps' block inside the 'Build' stage -> Option C

4. Quick Check:

   Declarative stages require steps block [OK]

Hint: Declarative stages always need a 'steps' block [OK]

Common Mistakes:

• Omitting the 'steps' block inside stages
• Confusing scripted and declarative syntax
• Thinking 'echo' must be replaced by 'sh'

5. You want to create a Jenkins pipeline that runs a complex Groovy script for dynamic branching but also wants to keep some stages simple and readable. Which approach is best?

hard

A. Use a fully scripted pipeline for all stages to keep consistency.

B. Use a declarative pipeline with a scripted block inside for complex parts.

C. Use only declarative pipeline and avoid any Groovy scripting.

D. Write two separate pipelines and run them manually.

Solution

1. Step 1: Understand pipeline flexibility needs

   Complex dynamic branching requires Groovy scripting flexibility, which scripted pipelines provide.

2. Step 2: Combine declarative simplicity with scripted flexibility

   Declarative pipelines allow embedding scripted blocks for advanced logic, keeping most stages simple and readable.

3. Final Answer:

   Use a declarative pipeline with a scripted block inside for complex parts. -> Option B

4. Quick Check:

   Declarative + scripted block = best of both worlds [OK]

Hint: Embed scripted blocks inside declarative for complex logic [OK]

Common Mistakes:

• Using only scripted pipeline losing readability
• Avoiding scripted blocks in declarative pipelines
• Running separate pipelines manually instead of combining