Environment directive in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the environment directive in a Jenkins pipeline?

The environment directive is used to define environment variables that will be available to all steps within the pipeline or stage. It helps set values like paths, credentials, or flags that the build process needs.

beginner

How do you define a simple environment variable named GREETING with the value Hello in a Jenkins declarative pipeline?

You define it inside the environment block like this:

environment {
  GREETING = 'Hello'
}

beginner

Can environment variables defined in the environment directive be used in shell script steps?

Yes, environment variables defined in the environment directive are accessible inside shell steps. For example, you can use $GREETING in a shell script to get the value.

intermediate

What happens if you define an environment variable with the same name in both the pipeline-level and stage-level environment blocks?

The stage-level environment variable overrides the pipeline-level one for that stage only. This allows customizing variables for specific stages.

intermediate

How can you use credentials securely with the environment directive in Jenkins?

You can use the credentials() helper inside the environment block to inject sensitive data like passwords or tokens securely. For example:

environment {
  MY_SECRET = credentials('my-credential-id')
}

Where do you place the environment directive in a Jenkins declarative pipeline?

A Outside the <code>pipeline</code> block

B Only inside <code>steps</code>

C Inside <code>post</code> block

D Inside the <code>pipeline</code> or <code>stage</code> blocks

The environment directive is placed inside the pipeline block to apply globally or inside a stage block to apply locally.

How do you reference an environment variable named VERSION inside a shell step?

A Use <code>env.VERSION</code>

B Use <code>VERSION()</code>

C Use <code>$VERSION</code>

D Use <code>#VERSION</code>

Inside shell scripts, environment variables are accessed with a dollar sign prefix, like $VERSION.

What is the correct syntax to define multiple environment variables in Jenkins pipeline?

A environment { VAR1 = 'one'; VAR2 = 'two' }

B environment { VAR1 = 'one' VAR2 = 'two' }

C environment (VAR1 = 'one', VAR2 = 'two')

D environment { VAR1 = 'one' VAR2 = 'two' }

Multiple variables are defined inside the environment block separated by new lines without semicolons or commas.

If you want to use a Jenkins credential as an environment variable, which function do you use?

A credentials()

B secret()

C env()

D secure()

The credentials() function injects credentials securely into environment variables.

What is the scope of environment variables defined inside a stage's environment block?

A Only available within that stage

B Available globally to all stages

C Available only in post steps

D Available only in parallel stages

Stage-level environment variables are limited to that stage's steps.

Explain how the environment directive works in Jenkins pipelines and how it affects the build steps.

Think about how you set variables that all commands can use during the build.

Describe how to securely use credentials with the environment directive in Jenkins.

Consider how Jenkins manages passwords or tokens safely.

Practice

1. What is the main purpose of the environment directive in a Jenkins pipeline?

easy

A. To define variables that can be used throughout the pipeline steps

B. To specify the build agent or node where the pipeline runs

C. To set the pipeline's timeout duration

D. To declare the stages of the pipeline

Solution

1. Step 1: Understand the role of environment directive

   The environment directive is used to set variables accessible in all pipeline steps.

2. Step 2: Compare with other pipeline directives

   Other directives like agent set the build node, and stages define pipeline stages, not environment variables.

3. Final Answer:

   To define variables that can be used throughout the pipeline steps -> Option A

4. Quick Check:

   Environment directive = set variables [OK]

Hint: Environment directive sets variables for all steps [OK]

Common Mistakes:

• Confusing environment with agent directive
• Thinking environment sets pipeline stages
• Assuming environment controls timeout

2. Which of the following is the correct syntax to set an environment variable GREETING with value Hello in a declarative Jenkins pipeline?

easy

A. environment { GREETING 'Hello' }

B. environment { GREETING: Hello }

C. environment { GREETING = Hello }

D. environment { GREETING = "Hello" }

Solution

1. Step 1: Recall environment variable syntax

   In Jenkins declarative pipelines, environment variables are set using environment { VAR = "value" } with quotes around string values.

2. Step 2: Check each option

   environment { GREETING = "Hello" } uses = with double quotes correctly.
   environment { GREETING: Hello } uses colon with unquoted Hello, syntax error (unresolved variable).
   environment { GREETING = Hello } misses quotes, syntax error.
   environment { GREETING 'Hello' } lacks assignment operator, syntax error.

3. Final Answer:

   environment { GREETING = "Hello" } -> Option D

4. Quick Check:

   Use double quotes for string values in environment [OK]

Hint: Use double quotes around string values in environment [OK]

Common Mistakes:

• Using colon instead of equals sign
• Omitting quotes around string values
• Using unquoted strings causing syntax errors

3. Given this Jenkins pipeline snippet:

pipeline {
  agent any
  environment {
    PATH = "/usr/local/bin"
    MESSAGE = "Build started"
  }
  stages {
    stage('Print') {
      steps {
        echo "$MESSAGE"
        sh 'echo $PATH'
      }
    }
  }
}

What will be the output when the Print stage runs?

medium

A. Build started
/usr/local/bin

B. $MESSAGE
$PATH

C. Build started
$PATH

D. Syntax error due to environment variables

Solution

1. Step 1: Understand environment variable usage

   The environment directive sets MESSAGE and PATH variables accessible in steps.

2. Step 2: Check echo and shell commands

   echo "$MESSAGE" prints the value of MESSAGE, which is "Build started". The shell command sh 'echo $PATH' prints the PATH variable value "/usr/local/bin".

3. Final Answer:

   Build started /usr/local/bin -> Option A

4. Quick Check:

   Environment variables expand correctly in echo and sh [OK]

Hint: Environment variables expand in echo and shell commands [OK]

Common Mistakes:

• Expecting literal variable names instead of values
• Confusing shell and Groovy variable syntax
• Assuming syntax error without cause

4. You wrote this environment block in your Jenkins pipeline:

environment {
  SECRET_KEY = secret123
}

But the pipeline fails with a syntax error. What is the most likely cause?

medium

A. Using an invalid variable name SECRET_KEY

B. Environment block must be inside a stage

C. Missing quotes around the string value

D. SECRET_KEY cannot contain numbers

Solution

1. Step 1: Check environment variable value syntax

   String values in environment variables must be quoted, e.g., SECRET_KEY = "secret123".

2. Step 2: Validate other options

   Variable names with underscores and numbers are valid. Environment block can be at pipeline level. Numbers in variable names are allowed.

3. Final Answer:

   Missing quotes around the string value -> Option C

4. Quick Check:

   Quote string values in environment variables [OK]

Hint: Always quote string values in environment directive [OK]

Common Mistakes:

• Forgetting quotes around strings
• Thinking variable names can't have underscores
• Placing environment block incorrectly

5. You want to set an environment variable VERSION dynamically based on a shell command output in a Jenkins declarative pipeline. Which approach correctly sets VERSION for use in later stages?

hard

A. Use environment { VERSION = sh(script: 'git describe --tags', returnStdout: true).trim() } directly in pipeline

B. Set VERSION inside a script block and use env.VERSION = ...

C. Declare VERSION as a parameter and assign shell output to it

D. Use environment { VERSION = "git describe --tags" } to run the command

Solution

1. Step 1: Understand environment directive limitations

   The environment directive cannot run shell commands directly; it only sets static values.

2. Step 2: Use script block to assign dynamic value

   Inside a script block, you can run shell commands and assign the output to env.VERSION for later use.

3. Step 3: Evaluate other options

   Use environment { VERSION = sh(script: 'git describe --tags', returnStdout: true).trim() } directly in pipeline tries to run shell in environment block which is invalid. Declare VERSION as a parameter and assign shell output to it misuses parameters. Use environment { VERSION = "git describe --tags" } to run the command assigns command string literally.

4. Final Answer:

   Set VERSION inside a script block and use env.VERSION = ... -> Option B

5. Quick Check:

   Dynamic env vars need script block assignment [OK]

Hint: Use script block to set dynamic environment variables [OK]

Common Mistakes:

• Trying to run shell commands directly in environment block
• Confusing parameters with environment variables
• Assigning command strings instead of output