Jenkinsfile concept - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Jenkinsfile?

A Jenkinsfile is a text file that contains the definition of a Jenkins pipeline. It tells Jenkins how to build, test, and deploy your project automatically.

intermediate

What are the two types of Jenkins pipelines you can define in a Jenkinsfile?

The two types are Declarative Pipeline and Scripted Pipeline. Declarative is simpler and structured, Scripted is more flexible and uses Groovy code.

beginner

Where should you store the Jenkinsfile in your project?

You should store the Jenkinsfile in the root directory of your project repository. This way, Jenkins can find it easily when it checks out your code.

beginner

How does Jenkins use the Jenkinsfile during a build?

Jenkins reads the Jenkinsfile to understand the steps to run. It executes those steps in order, like compiling code, running tests, and deploying, all automatically.

intermediate

Why is using a Jenkinsfile better than configuring jobs manually in Jenkins UI?

Using a Jenkinsfile keeps your pipeline as code, which means it is version controlled, easy to review, share, and reproduce. Manual UI setup is error-prone and hard to track.

What file name does Jenkins look for by default to define a pipeline?

A Dockerfile

B pipeline.txt

C build.gradle

D Jenkinsfile

Jenkins looks for a file named 'Jenkinsfile' in the root of the repository to define the pipeline.

Which language is primarily used inside a Jenkinsfile for scripted pipelines?

A Groovy

B Ruby

C JavaScript

D Python

Scripted pipelines in Jenkinsfiles use Groovy language syntax.

Where is the best place to store your Jenkinsfile?

A In the root of your project repository

B On a separate server

C In Jenkins server configuration

D In a cloud storage bucket

Storing the Jenkinsfile in the root of your project repository allows Jenkins to find and use it automatically.

What is a key benefit of using a Jenkinsfile over manual job configuration?

A It runs faster

B It requires no coding knowledge

C It allows pipeline as code with version control

D It uses less memory

Jenkinsfile enables pipeline as code, which means your build steps are stored in version control and easy to manage.

Which pipeline type in Jenkinsfile is simpler and uses a structured syntax?

A Scripted Pipeline

B Declarative Pipeline

C Manual Pipeline

D Automated Pipeline

Declarative Pipeline uses a simpler, structured syntax designed for easier writing and reading.

Explain what a Jenkinsfile is and why it is important in Jenkins automation.

Think about how Jenkins knows what steps to run automatically.

Describe the difference between Declarative and Scripted pipelines in a Jenkinsfile.

One is simpler and more readable, the other is more flexible.

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