Environment directive in Jenkins - Step-by-Step Execution

Process Flow - Environment directive

Start Pipeline

↓

Read environment directive

↓

Set environment variables

↓

Run pipeline steps with env vars

↓

Pipeline completes

The pipeline starts, reads the environment directive to set variables, then runs steps using those variables.

Execution Sample

Jenkins

pipeline {
  environment {
    GREETING = 'Hello'
    TARGET = 'World'
  }
  stages {
    stage('Example') {
      steps {
        echo "${GREETING}, ${TARGET}!"
      }
    }
  }
}

This Jenkins pipeline sets two environment variables and prints a greeting using them.

Process Table

Step	Action	Environment Variables Set	Output
1	Start pipeline	None yet	No output
2	Read environment directive	GREETING='Hello', TARGET='World'	No output
3	Run stage 'Example' steps	GREETING='Hello', TARGET='World'	Prints: Hello, World!
4	Pipeline completes	Environment variables cleared	Pipeline finished successfully

💡 Pipeline ends after all stages run with environment variables available

Status Tracker

Variable	Start	After Step 2	After Step 3	Final
GREETING	undefined	'Hello'	'Hello'	undefined
TARGET	undefined	'World'	'World'	undefined

Key Moments - 2 Insights

Why do environment variables disappear after the pipeline finishes?

Environment variables set in the environment directive exist only during the pipeline run (see execution_table step 4). After completion, Jenkins cleans up the environment.

Can I use environment variables in all stages once set in the environment directive?

Yes, environment variables set in the environment directive are available in all stages and steps (see execution_table step 3).

Visual Quiz - 3 Questions

Look at the execution table, at which step are the environment variables first set?

A Step 1

B Step 3

C Step 2

D Step 4

💡 Hint

Check the 'Environment Variables Set' column in the execution_table rows

According to the variable tracker, what is the value of GREETING after step 3?

A 'Hello'

B 'World'

C undefined

D null

💡 Hint

Look at the 'GREETING' row and 'After Step 3' column in variable_tracker

If you add a new variable in the environment directive, when will it be available?

A Only in the first stage

B In all stages and steps during the pipeline run

C Only after the pipeline finishes

D Only in the last stage

💡 Hint

Refer to key_moments about variable availability and execution_table step 3

Concept Snapshot

Jenkins environment directive sets variables for the entire pipeline run.
Syntax: environment { VAR = 'value' }
Variables are available in all stages and steps.
They exist only during pipeline execution.
Use ${VAR} to access them in steps.

Full Transcript

This visual execution shows how Jenkins pipeline uses the environment directive. The pipeline starts with no environment variables. Then it reads the environment directive and sets GREETING to 'Hello' and TARGET to 'World'. These variables are available in all stages and steps, as shown when the example stage prints 'Hello, World!'. After the pipeline finishes, the environment variables are cleared. This helps keep variables scoped to the pipeline run only. Beginners often wonder why variables disappear after the run or if variables are available everywhere. This trace clarifies those points by showing variable states and pipeline steps.

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