Steps within stages in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of steps within stages in a Jenkins pipeline?

Steps are the individual tasks or commands that run inside a stage. They define what actions Jenkins performs during that stage.

beginner

How do you define multiple steps inside a single stage in a Jenkins declarative pipeline?

You list the steps inside a steps block using commands like sh, echo, or script.

beginner

Example: What does this step do?

sh 'echo Hello World'

This step runs a shell command that prints 'Hello World' to the console output.

intermediate

Can a stage have zero steps in Jenkins pipeline?

No, a stage must have at least one step to perform an action. Otherwise, the stage does nothing and may cause errors.

beginner

How do steps inside stages help organize a Jenkins pipeline?

Steps inside stages break down the pipeline into clear, manageable actions. Each stage groups related steps, making the pipeline easier to read and maintain.

In Jenkins declarative pipeline, where do you put the commands to run inside a stage?

A Inside the agent block

B Inside the environment block

C Inside the steps block

D Inside the post block

Commands to run in a stage go inside the steps block.

Which of these is a valid step inside a Jenkins stage?

A sh 'ls -l'

B stage 'Build'

C pipeline { }

D agent any

The 'sh' command runs a shell command and is a valid step.

What happens if a stage has no steps defined?

A The stage runs successfully doing nothing

B The pipeline fails or errors out

C Jenkins skips the stage automatically

D The stage runs the previous steps again

A stage without steps usually causes an error because Jenkins expects actions to run.

How do steps inside stages improve a Jenkins pipeline?

A By making the pipeline run faster

B By skipping unnecessary builds

C By reducing the number of stages

D By grouping related tasks for clarity

Steps group tasks inside stages, making the pipeline easier to understand.

Which keyword is used to run a shell command as a step in Jenkins pipeline?

A sh

B run

C execute

D shell

The 'sh' keyword runs shell commands in Jenkins pipeline steps.

Explain how steps are used inside stages in a Jenkins pipeline and why they are important.

Think about what Jenkins does inside each stage.

Describe what happens if you define a stage without any steps in Jenkins pipeline.

Consider Jenkins expectations for stages.

Practice

1. What is the main purpose of steps inside a Jenkins stage?

easy

A. To define the actual commands or actions Jenkins will execute

B. To name the stage in the pipeline

C. To set environment variables for the pipeline

D. To configure Jenkins plugins

Solution

1. Step 1: Understand the role of stages

   Stages organize the pipeline into sections but do not run commands themselves.

2. Step 2: Identify what steps do inside stages

   Steps contain the actual commands or scripts Jenkins executes during that stage.

3. Final Answer:

   To define the actual commands or actions Jenkins will execute -> Option A

4. Quick Check:

   Steps = commands inside stages [OK]

Hint: Steps run commands; stages just group them [OK]

Common Mistakes:

• Confusing stage name with steps
• Thinking steps configure plugins
• Believing steps set environment variables

2. Which of the following is the correct syntax to define a step that prints 'Hello World' inside a Jenkins declarative pipeline stage?

easy

A. script { print 'Hello World' }

B. steps { echo 'Hello World' }

C. steps: echo('Hello World')

D. stage { echo 'Hello World' }

Solution

1. Step 1: Recall declarative pipeline syntax for steps

   Inside a stage, steps are defined with the steps { ... } block.

2. Step 2: Check the correct command to print

   The echo command prints messages in Jenkins pipelines.

3. Final Answer:

   steps { echo 'Hello World' } -> Option B

4. Quick Check:

   steps block + echo command = correct syntax [OK]

Hint: Use steps { echo 'text' } to print in Jenkins [OK]

Common Mistakes:

• Using stage instead of steps for commands
• Wrong colon syntax in steps
• Using print instead of echo

3. Given this Jenkins pipeline snippet, what will be the output in the console?

stage('Build') {
  steps {
    echo 'Starting build'
    sh 'echo Build complete'
  }
}

medium

A. Syntax error in pipeline

B. Build complete\nStarting build

C. Starting build only

D. Starting build\nBuild complete

Solution

1. Step 1: Understand the order of steps execution

   Steps run sequentially: first echo 'Starting build', then shell command sh 'echo Build complete'.

2. Step 2: Determine console output

   The first prints 'Starting build', the shell prints 'Build complete', so output is both lines in order.

3. Final Answer:

   Starting build\nBuild complete -> Option D

4. Quick Check:

   Steps run in order, echo then shell output [OK]

Hint: Steps run top to bottom, echo then shell output [OK]

Common Mistakes:

• Assuming shell output appears before echo
• Thinking only echo prints
• Confusing syntax causing errors

4. Identify the error in this Jenkins pipeline stage and how to fix it:

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

medium

A. stage keyword should be inside steps

B. echo command is invalid; use print instead

C. Missing curly braces {} after steps; add steps { ... }

D. No error; pipeline is correct

Solution

1. Step 1: Check syntax for steps block

   The steps block must have curly braces enclosing commands: steps { ... }.

2. Step 2: Identify missing braces causing syntax error

   Here, steps is followed directly by echo without braces, which is invalid.

3. Final Answer:

   Missing curly braces {} after steps; add steps { ... } -> Option C

4. Quick Check:

   steps block requires braces { } [OK]

Hint: Always wrap steps commands inside steps { } [OK]

Common Mistakes:

• Omitting braces after steps
• Using print instead of echo
• Placing stage inside steps

5. You want to run multiple shell commands sequentially inside a Jenkins stage. Which is the best way to organize these steps?

hard

A. Use a single sh step with commands separated by semicolons inside steps { }

B. Write multiple stage blocks, each with one sh command

C. Put all commands inside environment block

D. Use multiple steps blocks inside one stage

Solution

1. Step 1: Understand how to run multiple shell commands

   Multiple commands can be run in one sh step by separating them with semicolons.

2. Step 2: Identify correct pipeline structure

   Only one steps block is allowed per stage; multiple commands go inside one sh step or multiple steps inside the block.

3. Final Answer:

   Use a single sh step with commands separated by semicolons inside steps { } -> Option A

4. Quick Check:

   One steps block + one sh with multiple commands [OK]

Hint: Combine shell commands with semicolons inside one sh step [OK]

Common Mistakes:

• Using multiple stages for commands
• Trying multiple steps blocks inside one stage
• Putting commands in environment block