Skip to content

Standard Environment Variables

Rajan, Sarat edited this page Aug 15, 2019 · 1 revision

Standard Environment Variables

The following environment variables will be available to all build steps:

  • PIPELINE_APP_NAME (e.g. poet-test, defined in pipeline.global.appName)
  • PIPELINE_APP_VERSION
  • PIPELINE_BRANCH (e.g. feature/some_new_thing)
  • PIPELINE_BUILD_NUMBER (CI build number, e.g. 12)
  • PIPELINE_BUILD_STARTED (e.g. 1540921781)
  • PIPELINE_BUILD_URL (e.g. https://<pipeline-engine-url>/jenkins/job/Development/job/folder1/job/sample-pipeline/job/bug%252Fenv_vars_DE219663/3/)
  • PIPELINE_BUILD_URL_PATH (e.g. job/Development/job/folder1/job/sample-project/job/bug%252Fenv_vars_DE123456/3/)
  • PIPELINE_STATUS (SUCCESS or FAILURE)
  • PIPELINE_COMMIT_AUTHOR (git commit author, e.g. Larry.Ogrodnek)
  • PIPELINE_COMMIT_BRANCH (same as $PIPELINE_BRANCH).
  • PIPELINE_COMMIT_MESSAGE (git commit message, e.g. Updated readme.md)
  • PIPELINE_COMMIT_SHA (same as $PIPELINE_COMMIT)
  • PIPELINE_COMMIT (git commit hash, e.g. e27e4667a5a11145bb4eac9dd44db18dc793de3f)
  • PIPELINE_GIT_URL (e.g. https://github.com/tmobile/POET-pipeline-library.git).
  • PIPELINE_RUN_DISPLAY_URL (CI URL, e.g. https://<pipeline-engine-url>/jenkins/job/Development/job/sample-pipeline-v2/job/sample-pipeline/job/feature%252Fsample/12/display/redirect)
  • PIPELINE_WORKSPACE (absolute directory for workspace, e.g. /var/jenkins_home/workspace/sample-pipeline_workspace-DYISZFVFOQCUU65RQ7H3HDKNTEM2BK564YIUONN26SVO5WSRGDZQ)
  • PIPELINE_STATE_JSON (The file location of the PipelineState JSON object. See the Pipeline State JSON more information.)