How to list all env properties within jenkins pipeline job

Question

Given a jenkins build pipeline  jenkins injects a variable env into the node    Variable env holds environment variables and values  For example  environment variable BRANCH NAME can be accessed with node       echo   env BRANCH NAME           I want to echo all env properties within the jenkins pipeline    considering that I do not know all properties ahead of time  I am looking for code like node       for e in env           echo e    quot  is  quot      e                 which would echo something like  BRANCH NAME is myBranch2  CHANGE ID is 44        I used Jenkins 2 1 for this example

User · Answer

The easiest and quickest way is to use following url to print all environment variables http   localhost 8080 env-vars html

User · Answer

Why all this complicatedness   sh  env    does what you need  under  nix

User · Answer

The following works    NonCPS def printParams       env getEnvironment   each   name  value - gt  println  Name   name - gt  Value  value      printParams     Note that it will most probably fail on first execution and require you approve various groovy methods to run in jenkins sandbox  This is done in  manage jenkins in-process script approval   The list I got included    BUILD DISPLAY NAME BUILD ID BUILD NUMBER BUILD TAG BUILD URL CLASSPATH HUDSON HOME HUDSON SERVER COOKIE HUDSON URL JENKINS HOME JENKINS SERVER COOKIE JENKINS URL JOB BASE NAME JOB NAME JOB URL

User · Answer

if you really want to loop over the env list just do   def envs   sh returnStdout  true  script   env   split   n   envs each   name  - gt      println  Name   name

User · Answer

I suppose that you needed that in form of a script  but if someone else just want to have a look through the Jenkins GUI  that list can be found by selecting the  quot Environment Variables quot  section in contextual left menu of every build Select project   gt  Select build   gt  Environment Variables

User · Answer

You can get all variables from your jenkins instance  Just visit     jenkins host  env-vars html   jenkins host  pipeline-syntax globals

User · Answer

You can accomplish the result using sh bat step and readFile    node       sh  env  gt  env txt      readFile  env txt   split   r  n   each           println it           Unfortunately env getEnvironment   returns very limited map of environment variables

User · Answer

The pure Groovy solutions that read the global env variable don t print all environment variables  e  g  they are missing variables from the environment block  from withEnv context and most of the machine-specific variables from the OS   Using shell steps it is possible to get a more complete set  but that requires a node context  which is not always wanted   Here is a solution that uses the getContext step to retrieve and print the complete set of environment variables  including pipeline parameters  for the current context   Caveat  Doesn t work in Groovy sandbox  You can use it from a trusted shared library though   def envAll   getContext  hudson EnvVars   echo envAll collect  k  v - gt    k    v    join   n

User · Answer

The answers above  are now antiquated due to new pipeline syntax   Below prints out the environment variables   script           sh  env  gt  env txt          String   envs   readFile  env txt   split   r  n            for String vars  envs               println vars

User · Answer

Here s a quick script you can add as a pipeline job to list all environment variables   node       echo env getEnvironment   collect  environmentVariable - gt      environmentVariable key      environmentVariable value     join   n        echo System getenv   collect  environmentVariable - gt      environmentVariable key      environmentVariable value     join   n        This will list both system and Jenkins variables

User · Answer

I use Blue Ocean plugin and did not like each environment entry getting its own block  I want one block with all the lines   Prints poorly   sh  echo  env     Prints poorly   sh  env  gt  env txt  for  String i   readFile  env txt   split   r  n          println i     Prints well   sh  env  gt  env txt  sh  cat env txt    Prints well   as mentioned by  mjfroehlich   echo sh script   env   returnStdout  true

User · Answer

Cross-platform way of listing all environment variables   if  isUnix          sh env   else       bat set

User · Answer

Another  more concise way   node       echo sh returnStdout  true  script   env                  cf  https   jenkins io doc pipeline steps workflow-durable-task-step  code-sh-code-shell-script

User · Answer

another way to get exactly the output mentioned in the question   envtext   printenv  execute   text envtext split   n   each     envvar it split          println envvar 0    is   envvar 1      This can easily be extended to build a map with a subset of env vars matching a criteria   envdict     envtext   printenv  execute   text envtext split   n   each     envvar it split          if  envvar 0  startsWith  GERRIT             envdict put envvar 0  envvar 1         envdict each println it key   is   it value

User · Answer

Show all variable in Windows system and Unix system is different  you can define a function to call it every time  def showSystemVariables           if isUnix          sh  env       else        bat  set          I will call this function first to show all variables in all pipline script stage  1  Show all variables         steps            script                            showSystemVariables

User · Answer

I found this is the most easiest way  pipeline       agent           node               label  master                         stages           stage  hello world                 steps                   sh  env

User · Answer

According to Jenkins documentation for declarative pipeline   sh  printenv    For Jenkins scripted pipeline   echo sh script   env sort   returnStdout  true    The above also sorts your env vars for convenience

[jenkins] How to list all `env` properties within jenkins pipeline job?

Examples related to jenkins

Examples related to groovy

Examples related to jenkins-pipeline