Environment Variables#

This document describes the environment variables used in Semaphore projects.

Although some of the presented environment variables are defined on a per project or on a per task basis, all the presented environment variables can be seen on a per job basis.

If you're looking to set custom environment variables yourself, refer to this guide instead.

Predefined environment variables#

Semaphore defines and uses its own environment variables.

This group of environment variables includes the environment variables that are related to Semaphore 2.0 and hold information that is specific to Semaphore 2.0.

CI#

The value of the CI environment variable specifies whether we are in a Continuous Integration environment or not. The type of the CI variable is boolean.

Example value: true

SEMAPHORE#

The value of the SEMAPHORE environment variable says whether the job is executed in the Semaphore 2.0 environment or not and is a boolean variable.

Example value: true

SEMAPHORE_PROJECT_NAME#

The value of the SEMAPHORE_PROJECT_NAME environment variable holds the name of the project a job belongs to.

Example value: Documentation Project

SEMAPHORE_PROJECT_ID#

The value of the SEMAPHORE_PROJECT_ID environment variable holds the project ID of the project that a job belongs to.

Example value: 0dd982e8-32f5-4037-983e-4de01ac7fb1e

SEMAPHORE_ORGANIZATION_URL#

The value of the SEMAPHORE_ORGANIZATION_URL environment variable holds the url of organization that owns the project on Semaphore.

Example value: https://example.semaphoreci.com

SEMAPHORE_JOB_NAME#

The value of the SEMAPHORE_JOB_NAME environment variable is a string that holds the name of the job.

Example value: Push image to Docker

SEMAPHORE_JOB_ID#

The SEMAPHORE_JOB_ID environment variable holds the Job ID of the job that is being executed. It is the same value as is displayed in the output of the sem get jobs or the sem get jobs --all commands and is assigned by Semaphore 2.0.

Example value: a26d42cf-89ac-4c3f-9e2d-51bb231897bf

SEMAPHORE_JOB_RESULT#

The value of the SEMAPHORE_JOB_RESULT environment variable holds the result of a job. The list of values includes none, passed, failed and stopped.

Example value: passed

SEMAPHORE_WORKFLOW_ID#

The value of the SEMAPHORE_WORKFLOW_ID environment variable is the workflow ID that is used during the execution of the active job.

The SEMAPHORE_WORKFLOW_ID environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto promoted pipelines.

SEMAPHORE_WORKFLOW_NUMBER#

The value of the SEMAPHORE_WORKFLOW_NUMBER environment variable represents the current count of workflows on each distinct branch, tag or pull request. The first workflow in each of those gets the 1 for the value of SEMAPHORE_WORKFLOW_NUMBER and on each subsequent push or workflow rerun this value is increased by one.

The SEMAPHORE_WORKFLOW_NUMBER environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto promoted pipelines of the same workflow.

Example value: 42

SEMAPHORE_WORKFLOW_RERUN#

The value of the SEMAPHORE_WORKFLOW_RERUN environment variable is true if workflow is a rerun of a previously created workflow, otherwise, it is false.

The SEMAPHORE_WORKFLOW_RERUN environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto promoted pipelines of the same workflow.

Example value: false

SEMAPHORE_WORKFLOW_TRIGGERED_BY_HOOK#

The value of the SEMAPHORE_WORKFLOW_TRIGGERED_BY_HOOK environment variable is true if workflow run was triggered via hook from the git repository.

It has the value false in workflows which were triggered via cron scheduler feature or through Semaphore's API.

The SEMAPHORE_WORKFLOW_TRIGGERED_BY_HOOK environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto-promoted pipelines of the same workflow.

Example value: true

SEMAPHORE_WORKFLOW_TRIGGERED_BY_SCHEDULE#

The value of the SEMAPHORE_WORKFLOW_TRIGGERED_BY_SCHEDULE environment variable is true if workflow run was triggered via cron scheduler feature.

It has the value false in workflows which were triggered via hook from the git repository or through Semaphore's API.

The SEMAPHORE_WORKFLOW_TRIGGERED_BY_SCHEDULE environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto-promoted pipelines of the same workflow.

Example value: false

SEMAPHORE_WORKFLOW_TRIGGERED_BY_API#

The value of the SEMAPHORE_WORKFLOW_TRIGGERED_BY_API environment variable is true if workflow run was triggered through Semaphore's API.

It has the value false in workflows which were triggered via hook from the git repository or via cron scheduler feature.

The SEMAPHORE_WORKFLOW_TRIGGERED_BY_API environment variable remains the same during a pipeline run and is available in all the blocks of a pipeline as well as in all promoted and auto-promoted pipelines of the same workflow.

Example value: false

SEMAPHORE_PIPELINE_ID#

The value of the SEMAPHORE_PIPELINE_ID environment variable is the pipeline ID that is used for the execution of the active job.

The SEMAPHORE_PIPELINE_ID environment variable remains the same throughout all the blocks of a pipeline, which makes it the perfect candidate for sharing data inside the same pipeline.

Example value: ea3e6bba-d19a-45d7-86a0-e78a2301b616

SEMAPHORE_PIPELINE_PROMOTION#

The value of the SEMAPHORE_PIPELINE_PROMOTION environment variable is true if the pipeline is started via the promotion of some other pipeline.

It has the value false only in the initial pipeline which is created when workflow is created.

The SEMAPHORE_PIPELINE_PROMOTION environment variable remains the same throughout all the blocks of a pipeline.

Example value: false

SEMAPHORE_PIPELINE_PROMOTED_BY#

The value of the SEMAPHORE_PIPELINE_PROMOTED_BY environment variable is auto-promotion if the pipeline is auto-promoted.

If the pipeline is manually promoted, the value is the GitHub username of the person that promoted the pipeline.

However, if it is an initial pipeline, the value of the environment variable is an empty string.

Example value: auto-promotion

SEMAPHORE_PIPELINE_RERUN#

The value of the SEMAPHORE_PIPELINE_RERUN environment variable is true if the pipeline is a rerun of a previously failed pipeline, otherwise, it is false.

Note: Pipeline reruns are in the alpha phase of development and only available through CLI.

The SEMAPHORE_PIPELINE_RERUN environment variable remains the same throughout all the blocks of a pipeline.

Example value: false

SEMAPHORE_AGENT_MACHINE_TYPE#

The value of the SEMAPHORE_AGENT_MACHINE_TYPE environment variable specifies the type of agent used in the job that is being executed.

Example value: e1-standard-4

SEMAPHORE_AGENT_MACHINE_OS_IMAGE#

The value of the SEMAPHORE_AGENT_MACHINE_OS_IMAGE environment variable represents the operating system image that is being used.

Example value: ubuntu1804

SEMAPHORE_AGENT_MACHINE_ENVIRONMENT_TYPE#

The value of the SEMAPHORE_AGENT_MACHINE_ENVIRONMENT_TYPE environment variable specifies the type of environment in which the job is being executed, inside the container or inside the VM.

Example value: container

This group of environment variables includes environment variables that are used by Semaphore 2.0 and are related to GitHub and the GitHub repository that is used in the current Semaphore 2.0 project.

SEMAPHORE_GIT_SHA#

The value of the SEMAPHORE_GIT_SHA environment variable holds the current revision of code that the pipeline is using.

Example values: 5c84719708b9b649b9ef3b56af214f38cee6acde, HEAD

SEMAPHORE_GIT_URL#

The value of the SEMAPHORE_GIT_URL environment variable is the URL of the GitHub repository used in the current Semaphore 2.0 project.

Example value: http://git@github.com:semaphoreci/toolbox.git

SEMAPHORE_GIT_BRANCH#

The value of the SEMAPHORE_GIT_BRANCH environment variable is the name of the GitHub branch that is used in the current job.

In builds triggered by a Pull Request the value of the SEMAPHORE_GIT_BRANCH is the name of the GitHub branch targeted by the Pull Request.

Example value: development

SEMAPHORE_GIT_DIR#

The value of the SEMAPHORE_GIT_DIR environment variable is the name of the directory that contains the files of the GitHub repository of the current Semaphore 2.0 project.

Example value: foo

SEMAPHORE_GIT_REPO_SLUG#

The value of the SEMAPHORE_GIT_REPO_SLUG environment variable is the name (in form: owner_name/repo_name) of the GitHub repository of the current Semaphore 2.0 project.

Example value: semaphoreci/docs

SEMAPHORE_GIT_REF_TYPE#

The value of the SEMAPHORE_GIT_REF_TYPE environment variable indicates the git reference type.

Example value: branch, tag, pull-request

SEMAPHORE_GIT_REF#

The value of the SEMAPHORE_GIT_REF environment variable holds the name of git reference to commit that the pipeline is using.

Example value: refs/heads/master

SEMAPHORE_GIT_COMMIT_RANGE#

The value of the SEMAPHORE_GIT_COMMIT_RANGE environment variable holds the range of commits that were included in the push or pull request.

This is empty for builds triggered by the initial commit of a new branch or tag.

Example value: 5c84719708b9b649b9ef3b56af214f38cee6acde...92d87d5c0dd2dbb7a68ecb27df43d1b164fd3e30

SEMAPHORE_GIT_TAG_NAME#

The value of the SEMAPHORE_GIT_TAG_NAME environment variable is the name of the GitHub tag that is used in the current job.

Example value: v1.0.0

SEMAPHORE_GIT_PR_BRANCH#

The value of the SEMAPHORE_GIT_PR_BRANCH environment variable is the name of the GitHub branch from which the Pull Request originated.

SEMAPHORE_GIT_PR_SLUG#

The value of the SEMAPHORE_GIT_PR_SLUG environment variable is the name (in form: owner_name/repo_name) of the GitHub repository from which the Pull Request originated.

Example value: renderedtext/docs

SEMAPHORE_GIT_PR_SHA#

The value of the SEMAPHORE_GIT_PR_SHA environment variable holds the commit SHA of the HEAD commit of the Pull Request.

Example values: 5c84719708b9b649b9ef3b56af214f38cee6acd3

SEMAPHORE_GIT_PR_NUMBER#

The value of the SEMAPHORE_GIT_PR_NUMBER environment variable holds the number of the Pull Request.

Example values: 1

SEMAPHORE_GIT_PR_NAME#

The value of the SEMAPHORE_GIT_PR_NAME environment variable holds the name of the Pull Request.

Example values: Update Readme.md

The following environment variables are related to the cache utility. You can find more information about the cache utility at Toolbox reference.

SEMAPHORE_CACHE_USERNAME#

The value of the SEMAPHORE_CACHE_USERNAME environment variable is the username that will be used for connecting to the cache server.

Example value: 0614ef08af7a408d8aae45b029ba3bb8

SEMAPHORE_CACHE_URL#

The value of the SEMAPHORE_CACHE_URL environment variable is the IP address and the port number of the cache server.

Example value: 94.130.158.146:29920

SEMAPHORE_CACHE_PRIVATE_KEY_PATH#

The value of the SEMAPHORE_CACHE_PRIVATE_KEY_PATH environment variable is the path to the file that contains the SSH key to the cache server.

Example value: /home/semaphore/.ssh/semaphore_cache_key

Private Docker registry is a beta feature that is available on a request.

This feature adds the following environment variables to every job for a given project:

  • SEMAPHORE_REGISTRY_USERNAME - Semaphore private Docker Registry username
  • SEMAPHORE_REGISTRY_PASSWORD - Semaphore private Docker Registry password
  • SEMAPHORE_REGISTRY_URL - Semaphore private Docker Registry url

See Also#