Declarative pipeline syntax in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Declarative Pipeline in Jenkins?

A Declarative Pipeline is a simple and structured way to define Jenkins pipelines using a clear syntax that focuses on what to do, not how to do it. It uses a pipeline block with stages and steps.

beginner

What is the purpose of the stages block in a Declarative Pipeline?

The stages block groups multiple stage blocks, each representing a phase in the pipeline like build, test, or deploy. It organizes the pipeline flow clearly.

beginner

How do you define an agent in a Declarative Pipeline and what does it do?

The agent specifies where the pipeline or a stage runs, like on any available machine (agent any) or a specific label. It tells Jenkins which environment to use.

beginner

What is the function of the steps block inside a stage?

The steps block contains the actual commands or actions Jenkins will perform during that stage, like running shell commands or scripts.

intermediate

How does Declarative Pipeline improve readability compared to Scripted Pipeline?

Declarative Pipeline uses a fixed, easy-to-read structure with clear blocks like pipeline, stages, and steps. It avoids complex scripting, making it easier for beginners to understand.

Which block defines the overall pipeline in Declarative syntax?

A steps

B stage

C pipeline

D agent

The pipeline block is the root block that defines the entire Declarative Pipeline.

What does agent any mean in a Declarative Pipeline?

A Run only on master node

B Run on any available agent

C Run without an agent

D Run on a specific labeled agent

agent any tells Jenkins to run the pipeline on any available agent.

Where do you put the commands to execute in a Declarative Pipeline?

A inside the steps block

B inside the agent block

C inside the environment block

D inside the options block

Commands or scripts to run are placed inside the steps block.

Which block groups multiple stages in a Declarative Pipeline?

A environment

B steps

C agent

D stages

The stages block contains multiple stage blocks.

What is a key benefit of Declarative Pipeline syntax?

A It is easier to read and write for beginners

B It allows unlimited scripting flexibility

C It requires no syntax rules

D It runs only on Windows agents

Declarative Pipeline is designed to be simple and readable, especially for beginners.

Explain the main structure of a Jenkins Declarative Pipeline and the role of its key blocks.

Think about how you organize a recipe with ingredients and steps.

Describe how you specify where a Jenkins Declarative Pipeline runs and why this is important.

Consider choosing a kitchen to cook your recipe.

Practice

1. Which block is mandatory to start a Jenkins declarative pipeline?

easy

A. stage

B. agent

C. steps

D. pipeline

Solution

1. Step 1: Understand the pipeline structure

   The pipeline block is the root block that wraps the entire declarative pipeline script.

2. Step 2: Identify mandatory blocks

   While agent, stages, and steps are important, the pipeline block is always required to define the pipeline.

3. Final Answer:

   <code>pipeline</code> -> Option D

4. Quick Check:

   Root block = pipeline [OK]

Hint: Look for the root block that wraps everything [OK]

Common Mistakes:

• Confusing stage as root block
• Thinking steps is the top block
• Assuming agent is mandatory alone

2. Which of the following is the correct syntax to define an agent that runs on any available node?

easy

A. agent any

B. agent: any

C. agent { any }

D. agent = any

Solution

1. Step 1: Recall agent syntax in declarative pipeline

   The correct syntax to specify an agent that runs on any available node is agent any without punctuation.

2. Step 2: Check other options for syntax errors

   Options with colons, braces, or equals signs are invalid in declarative pipeline syntax for agent.

3. Final Answer:

   agent any -> Option A

4. Quick Check:

   Agent syntax is simple: agent any [OK]

Hint: Remember: no punctuation, just 'agent any' [OK]

Common Mistakes:

• Adding colons or braces around 'any'
• Using equals sign instead of space
• Confusing scripted pipeline syntax

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

pipeline {
  agent any
  stages {
    stage('Hello') {
      steps {
        echo 'Hello World'
      }
    }
  }
}

medium

A. Fails because 'echo' is not allowed in declarative pipeline

B. Prints 'Hello World' in the build log

C. Pipeline runs but no output is shown

D. Syntax error due to missing agent label

Solution

1. Step 1: Analyze the pipeline structure

   The pipeline has a valid agent any, one stage named 'Hello', and a step that echoes 'Hello World'.

2. Step 2: Understand the echo step behavior

   The echo step prints the given message to the Jenkins build log during execution.

3. Final Answer:

   Prints 'Hello World' in the build log -> Option B

4. Quick Check:

   echo prints message to log [OK]

Hint: echo always prints text to Jenkins console [OK]

Common Mistakes:

• Thinking echo is disallowed in declarative pipelines
• Assuming missing agent label causes error here
• Believing pipeline runs silently without output

4. Identify the error in this declarative pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        sh 'make build'
      }
    }
  }
  steps {
    echo 'Done'
  }
}

medium

A. The sh command is invalid in declarative pipeline

B. Missing agent block

C. The steps block is misplaced outside stage

D. The stage block must be outside stages

Solution

1. Step 1: Review pipeline block structure

   In declarative pipelines, steps must be inside a stage block, which is inside stages.

2. Step 2: Locate the misplaced steps block

   The steps block with echo 'Done' is incorrectly placed directly under pipeline, outside any stage.

3. Final Answer:

   The <code>steps</code> block is misplaced outside <code>stage</code> -> Option C

4. Quick Check:

   steps must be inside stage [OK]

Hint: steps always go inside a stage block [OK]

Common Mistakes:

• Placing steps directly under pipeline
• Confusing agent placement
• Thinking sh is invalid in declarative pipelines

5. You want to run two stages in parallel in a declarative pipeline. Which snippet correctly defines parallel stages?

hard

A. pipeline {
agent any
stages {
stage('Parallel') {
parallel {
stage('Test') {
steps { echo 'Testing' }
}
stage('Build') {
steps { echo 'Building' }
}
}
}
}
}

B. pipeline {
agent any
stages {
parallel {
stage('Test') {
steps { echo 'Testing' }
}
stage('Build') {
steps { echo 'Building' }
}
}
}
}

C. pipeline {
agent any
stages {
stage('Test') {
steps { echo 'Testing' }
}
stage('Build') {
steps { echo 'Building' }
}
}
}

D. pipeline {
agent any
parallel {
stage('Test') {
steps { echo 'Testing' }
}
stage('Build') {
steps { echo 'Building' }
}
}
}

Solution

1. Step 1: Understand parallel syntax in declarative pipeline

   Parallel stages must be nested inside a stage block using the parallel block.

2. Step 2: Check each option for correct structure

   pipeline {
     agent any
     stages {
       stage('Parallel') {
         parallel {
           stage('Test') {
             steps { echo 'Testing' }
           }
           stage('Build') {
             steps { echo 'Building' }
           }
         }
       }
     }
   }

   correctly places parallel inside a stage named 'Parallel' with nested stages 'Test' and 'Build'. Other options place parallel incorrectly or omit it.

3. Final Answer:

   Option A with parallel inside a stage block -> Option A

4. Quick Check:

   parallel inside stage block = correct [OK]

Hint: Parallel block must be inside a stage block [OK]

Common Mistakes:

• Placing parallel directly under stages
• Omitting the parallel block
• Placing parallel outside pipeline