How to set PATH in Jenkins Declarative Pipeline

41
votes

In Jenkins scripted pipeline you can set PATH env variable like this :

node {
   git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
   withEnv(["PATH+MAVEN=${tool 'M3'}/bin"]) {
      sh 'mvn -B verify'
   }
}

Notice the PATH+MAVEN as explained here https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#code-withenv-code-set-environment-variables :

A list of environment variables to set, each in the form VARIABLE=value or VARIABLE= to unset variables otherwise defined. You may also use the syntax PATH+WHATEVER=/something to prepend /something to $PATH.

But I didn't find how to do it in declarative pipeline using environment syntax (as explained here : https://jenkins.io/doc/pipeline/tour/environment).

environment {
    DISABLE_AUTH = 'true'
    DB_ENGINE    = 'sqlite'
}

Ideally I would like to update the PATH to use custom tools for all my stages.

4
jenkinspathenvironment-variablesjenkins-pipeline

4 Answers

69
votes

It is possible with environment section:

pipeline {
  agent { label 'docker' }
  environment {
    PATH = "/hot/new/bin:${env.PATH}"
  }
  stages {
    stage ('build') {
      steps {
        echo "PATH is: ${env.PATH}"
      }
    }
  }
}

See this answer for info.

5
votes

As a workaround, you can define an environment variable and use it in the sh step:

pipeline {
    environment {
        MAVEN_HOME = tool('M3')
    }

    stages {
        stage(Maven') {
           sh '${MAVEN_HOME}/bin/mvn -B verify'
        }
    }
}
1
votes

Check the following link, this explains how to configure your tools. Using the declarative pipeline things become a bit different but overall it is easier to understand.

declarative-maven-project

1
votes

Using the tool section in pipeline is only allowed for pre-installed Global Tools. Some tools are provided by plugins, but if it not exists I'am afraid you cannot use the environment setup via pipeline tool declaration.

I hope to be wrong!