Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-27145

Advertise available environment variables




      Right now there is no easy way to find, when writing a flow script, which environment variables will be predefined.

      EnvironmentContributor/EnvVarsHtml/index.groovy renders CoreEnvironmentContributor/buildEnv.groovy. This will be somewhat misleading since EXECUTOR_NUMBER, NODE_NAME, and NODE_LABELS are not currently set for flow builds (since they do not make sense in general, and buildEnvironment is not going to be called from an Executor thread). This page also seems to be documenting variables that CoreEnvironmentContributor does not actually set, including WORKSPACE (from AbstractBuild.getEnvironment) which is also not currently available for flow builds. Setting these variables from ExecutorStepExecution would be welcome. (BUILD_NUMBER, BUILD_ID, and BUILD_TAG are from Run.getCharacteristicEnvVars and are available for flows; likewise JOB_NAME from Job.getCharacteristicEnvVars—curiously JOB_URL is set by CoreEnvironmentContributor.)

      At any rate, linking to this page (${rootURL}/env-vars.html) from somewhere in the configuration page for a script would be welcome. Perhaps from help.* of the sh/bat scripts, analogous to the standard Jenkins usage from hudson/tasks/Shell/config.properties etc.?


        Issue Links


            jglick Jesse Glick created issue -
            tfennelly Tom FENNELLY made changes -
            Field Original Value New Value
            Status Open [ 1 ] In Progress [ 3 ]
            jglick Jesse Glick made changes -
            Assignee Jesse Glick [ jglick ] Tom FENNELLY [ tfennelly ]
            jglick Jesse Glick made changes -
            Remote Link This issue links to "PR 75 (Web Link)" [ 12142 ]
            jglick Jesse Glick made changes -
            Link This issue is related to JENKINS-26128 [ JENKINS-26128 ]
            tfennelly Tom FENNELLY made changes -
            Resolution Fixed [ 1 ]
            Status In Progress [ 3 ] Resolved [ 5 ]
            jglick Jesse Glick made changes -
            Link This issue depends on JENKINS-28131 [ JENKINS-28131 ]
            rtyler R. Tyler Croy made changes -
            Workflow JNJira [ 161341 ] JNJira + In-Review [ 196723 ]
            abayer Andrew Bayer made changes -
            Component/s pipeline-general [ 21692 ]
            abayer Andrew Bayer made changes -
            Component/s workflow-plugin [ 18820 ]


              tfennelly Tom FENNELLY
              jglick Jesse Glick
              0 Vote for this issue
              2 Start watching this issue