When to use scripted over declarative in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main difference between scripted and declarative Jenkins pipelines?

Scripted pipelines use Groovy code and offer more flexibility and control. Declarative pipelines use a simpler, structured syntax designed for easier readability and maintenance.

beginner

When should you choose a scripted pipeline over a declarative pipeline in Jenkins?

Use scripted pipelines when you need complex logic, dynamic behavior, or advanced Groovy scripting that declarative syntax cannot easily express.

beginner

What is a key benefit of declarative pipelines compared to scripted pipelines?

Declarative pipelines are easier to read and maintain, making them better for simple to moderately complex workflows and for teams new to Jenkins pipelines.

intermediate

Can scripted pipelines handle conditional logic better than declarative pipelines?

Yes, scripted pipelines allow full Groovy scripting, so you can write complex conditional logic that is harder or impossible in declarative syntax.

intermediate

Is it possible to mix scripted and declarative syntax in Jenkins pipelines?

Yes, you can embed scripted pipeline code inside a declarative pipeline using the 'script' block for advanced logic when needed.

Which Jenkins pipeline type is best for simple, easy-to-read workflows?

A Declarative pipeline

B Scripted pipeline

C Both are equally simple

D Neither is suitable

Declarative pipelines use a structured syntax designed for simplicity and readability.

When do you prefer scripted pipelines over declarative pipelines?

A When you want a graphical interface

B For very simple workflows

C To avoid writing any code

D When you need complex Groovy scripting

Scripted pipelines allow full Groovy code for complex logic and dynamic behavior.

Can declarative pipelines include scripted pipeline code?

A Only in Jenkins versions before 2.0

B No, they are completely separate

C Yes, inside a 'script' block

D Only if you use plugins

Declarative pipelines support embedding scripted code inside 'script' blocks.

Which pipeline type requires more Groovy knowledge?

A Scripted pipeline

B Declarative pipeline

C Both require the same

D Neither requires Groovy

Scripted pipelines are Groovy code, so they require more Groovy knowledge.

What is a common reason to avoid scripted pipelines?

A They are deprecated

B They are harder to read and maintain

C They do not support parallel steps

D They cannot handle complex logic

Scripted pipelines offer flexibility but can be harder to read and maintain compared to declarative pipelines.

Explain when and why you would choose a scripted Jenkins pipeline instead of a declarative one.

Think about the complexity of your pipeline and the scripting capabilities you need.

Describe the benefits of using declarative pipelines and situations where they are preferred over scripted pipelines.

Consider the ease of use and team collaboration aspects.

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