Jenkinsfile concept - Step-by-Step Execution

Process Flow - Jenkinsfile concept

Start Jenkinsfile

↓

Define pipeline

↓

Specify stages

↓

Execute each stage sequentially

↓

Run steps inside stages

↓

Complete pipeline

↓

End

This flow shows how Jenkins reads a Jenkinsfile, defines the pipeline, runs each stage step-by-step, and finishes.

Execution Sample

Jenkins

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

A simple Jenkinsfile defining a pipeline with one stage that prints 'Building...'.

Process Table

Step	Action	Evaluation	Result
1	Start Jenkinsfile parsing	Read 'pipeline' block	Pipeline object created
2	Set agent	agent any	Agent set to any available node
3	Enter stages block	Read stages	Stages container created
4	Define stage 'Build'	stage('Build')	Stage 'Build' added
5	Enter steps block	steps { echo 'Building...' }	Steps defined for 'Build' stage
6	Execute stage 'Build'	Run echo 'Building...'	Output: Building...
7	Pipeline complete	All stages done	Pipeline finished successfully

💡 All stages executed, pipeline ends

Status Tracker

Variable	Start	After Step 2	After Step 4	After Step 6	Final
pipeline	undefined	defined	defined with stages	executing stage 'Build'	completed

Key Moments - 3 Insights

Why does the pipeline stop after all stages run?

The execution_table row 7 shows the pipeline finishes because all defined stages have completed their steps.

What does 'agent any' mean in the Jenkinsfile?

Row 2 explains 'agent any' means Jenkins can run the pipeline on any available node, making it flexible.

How are steps inside a stage executed?

Row 6 shows steps inside a stage run sequentially; here, the echo command runs and outputs text.

Visual Quiz - 3 Questions

Look at the execution table, what is the result after step 4?

A Agent set to any available node

B Pipeline finished successfully

C Stage 'Build' added

D Output: Building...

💡 Hint

Check the 'Result' column in row 4 of the execution_table.

At which step does the pipeline actually run the echo command?

A Step 3

B Step 6

C Step 5

D Step 7

💡 Hint

Look for the step where 'Run echo' is mentioned in the 'Action' column.

If we remove 'agent any', what would happen to the pipeline execution?

A Pipeline fails to run due to no agent specified

B Pipeline skips stages

C Pipeline runs on any node anyway

D Pipeline runs only on master node

💡 Hint

Refer to the explanation in key_moments about the role of 'agent any' in step 2.

Concept Snapshot

Jenkinsfile defines a pipeline as code.
Use 'pipeline' block with 'agent' and 'stages'.
Each 'stage' has 'steps' to run commands.
Jenkins runs stages sequentially.
'agent any' lets Jenkins pick any node.
Pipeline ends after all stages complete.

Full Transcript

A Jenkinsfile is a text file that tells Jenkins how to run a pipeline. It starts with the 'pipeline' block, where you set the 'agent' to choose where to run the work. Inside, you define 'stages' which are steps like Build or Test. Each stage has 'steps' that run commands. Jenkins reads the file, sets up the pipeline, and runs each stage one by one. For example, a stage might print 'Building...'. When all stages finish, the pipeline ends successfully.

Practice

1. What is the main purpose of a Jenkinsfile in Jenkins?

easy

A. To configure Jenkins server settings

B. To define the steps and stages of a build process in code

C. To store Jenkins user credentials securely

D. To create a backup of Jenkins jobs

Solution

1. Step 1: Understand Jenkinsfile role

   A Jenkinsfile is a text file that defines the build process in Jenkins using code.

2. Step 2: Compare options with Jenkinsfile purpose

   Only To define the steps and stages of a build process in code describes defining build steps and stages, which is the Jenkinsfile's main role.

3. Final Answer:

   To define the steps and stages of a build process in code -> Option B

4. Quick Check:

   Jenkinsfile = build process code [OK]

Hint: Jenkinsfile scripts the build steps in code [OK]

Common Mistakes:

• Confusing Jenkinsfile with Jenkins server config
• Thinking Jenkinsfile stores credentials
• Assuming Jenkinsfile is for backup

2. Which of the following is the correct way to start a declarative pipeline in a Jenkinsfile?

easy

A. pipeline {

B. stage {

C. node {

D. build {

Solution

1. Step 1: Recall declarative pipeline syntax

   A declarative pipeline always starts with the keyword pipeline { to define the pipeline block.

2. Step 2: Check other options

   stage { defines a stage inside the pipeline, node { is used in scripted pipelines, and build { is not a valid top-level block.

3. Final Answer:

   pipeline { -> Option A

4. Quick Check:

   Declarative pipeline starts with pipeline { [OK]

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

Common Mistakes:

• Starting with stage instead of pipeline
• Using node block in declarative pipeline
• Using invalid block names like build

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

pipeline {
  agent any
  stages {
    stage('Example') {
      steps {
        echo 'Hello, Jenkins!'
      }
    }
  }
}

medium

A. pipeline syntax error

B. No output, pipeline skipped

C. Hello, Jenkins!

D. Stage 'Example' failed

Solution

1. Step 1: Analyze the pipeline structure

   The pipeline has one stage named 'Example' with a step that echoes 'Hello, Jenkins!'.

2. Step 2: Understand echo step behavior

   The echo step prints the given message to the Jenkins console output during the build.

3. Final Answer:

   Hello, Jenkins! -> Option C

4. Quick Check:

   echo prints message = Hello, Jenkins! [OK]

Hint: echo prints text to console output [OK]

Common Mistakes:

• Assuming syntax error without checking code
• Thinking pipeline skips stages by default
• Confusing echo with failure

4. Identify the error in this Jenkinsfile snippet:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        sh 'mvn clean install'
      }
    }
  }
  post {
    always {
      echo 'Build finished'
    }
  }
}

medium

A. sh step requires double quotes instead of single quotes

B. Incorrect placement of post block outside pipeline

C. Missing closing brace for stages block

D. No error, syntax is correct

Solution

1. Step 1: Check block structure

   All blocks (pipeline, stages, stage, steps, post) are properly opened and closed.

2. Step 2: Validate syntax rules

   The post block is correctly placed inside the pipeline block. The sh step accepts single or double quotes.

3. Final Answer:

   No error, syntax is correct -> Option D

4. Quick Check:

   Proper block structure = no syntax error [OK]

Hint: Check matching braces and block placement [OK]

Common Mistakes:

• Assuming post block must be inside stages
• Thinking single quotes cause error in sh step
• Missing braces in nested blocks

5. You want to add a stage in your Jenkinsfile that only runs tests if the branch is 'main'. Which snippet correctly implements this conditional stage?

hard

A. stage('Test') {
when {
branch 'main'
}
steps {
echo 'Running tests'
}
}

B. stage('Test') {
if (env.BRANCH_NAME == 'main') {
steps {
echo 'Running tests'
}
}
}

C. stage('Test') {
steps {
if (branch == 'main') {
echo 'Running tests'
}
}
}

D. stage('Test') {
when {
environment 'main'
}
steps {
echo 'Running tests'
}
}

Solution

1. Step 1: Understand Jenkins conditional syntax

   Declarative pipelines use the when block with branch 'branchName' to conditionally run stages.

2. Step 2: Evaluate each option

   stage('Test') { when { branch 'main' } steps { echo 'Running tests' } } correctly uses when { branch 'main' }. stage('Test') { if (env.BRANCH_NAME == 'main') { steps { echo 'Running tests' } } } uses scripted style inside declarative, which is invalid. stage('Test') { steps { if (branch == 'main') { echo 'Running tests' } } } tries to use if inside steps, which is not supported. stage('Test') { when { environment 'main' } steps { echo 'Running tests' } } uses environment incorrectly.

3. Final Answer:

   stage('Test') { when { branch 'main' } steps { echo 'Running tests' } } -> Option A

4. Quick Check:

   Use when { branch 'name' } for conditional stages [OK]

Hint: Use when { branch 'main' } to run stage conditionally [OK]

Common Mistakes:

• Using if statements inside declarative stages
• Misusing environment instead of branch in when
• Placing condition inside steps block