Skip to main content

Environment variables

Semaphore variables​

These variables describe various aspects of Semaphore workings.

CI​

  • Environment variable: CI
  • Example: true

Holds true when the session runs in a Semaphore continuous integration (CI) environment.

Semaphore​

  • Environment variable: SEMAPHORE
  • Example: true

Holds true when the session is running in a Semaphore environment.

Agent environment type​

  • Environment variable: SEMAPHORE_AGENT_MACHINE_ENVIRONMENT_TYPE
  • Example: container

Defines the type of environment for the current job.

Possible values are:

  • container: job running inside a Docker container
  • VM: job running on a virtual machine

Agent OS image​

  • Environment variable: SEMAPHORE_AGENT_MACHINE_OS_IMAGE
  • Example: ubuntu2004

The name of the operating system image active in the current job.

See machine types for all available options.

Agent machine type​

  • Environment variable: SEMAPHORE_AGENT_MACHINE_TYPE
  • Example: e1-standard-2

The type of agent running the current job.

See machine types for all available options.

Job creation time​

  • Environment variable: SEMAPHORE_JOB_CREATION_TIME
  • Example: 1632943641

The UNIX epoch seconds when the current job was created.

Job id​

  • Environment variable: SEMAPHORE_JOB_ID
  • Example: a26d42cf-89ac-4c3f-9e2d-51bb231897bf

The unique identifier for the current job. Semaphore automatically generates unique IDs for every job.

You can view all the job IDs using the sem CLI:

  • Get active jobs: execute sem get jobs
  • Get most recent jobs: execute sem get jobs --all

Job name​

  • Environment variable: SEMAPHORE_JOB_NAME
  • Example: Push image to Docker

A string with a user-supplied name for the job.

Job count​

  • Environment variable: SEMAPHORE_JOB_COUNT
  • Example: 4

Only available when job parallelism is enabled. This variable holds the total number of jobs configured in job parallelism.

It can be used to configure a test partitioning strategy using a 3rd party test runner.

Job index​

  • Environment variable: SEMAPHORE_JOB_INDEX
  • Example: 1

Only available when job parallelism is enabled. This is a 1-based index that represents the current job instance in parallel set. The value ranges between 1 and SEMAPHORE_JOB_COUNT.

It can be used to configure a test partitioning strategy using a 3rd party test runner.

Job result​

  • Environment variable: SEMAPHORE_JOB_RESULT
  • Example: passed

Describes the ending state of the job. The possible states are:

  • none: the job has not yet finished
  • passed: the job finished successfully
  • failed: the job finished in failure
  • stopped: the job was terminated before completion
note

This variable is only available in the job epilogue.

Job type​

  • Environment variable: SEMAPHORE_JOB_TYPE
  • Example: pipeline_job

Describes why the current job was created. The possible values are:

  • pipeline_job: a regular job created by Semaphore as part of the workflow
  • project_debug_job: job created with sem debug project
  • debug_job: job created with sem debug job

Organization URL​

  • Environment variable: SEMAPHORE_ORGANIZATION_URL
  • Example: https://my-org.semaphoreci.com

The URL for the organization that owns the project running the current job.

Pipeline ID​

  • Environment variable: SEMAPHORE_PIPELINE_ID
  • Example: ea3e6bba-d19a-45d7-86a0-e78a2301b616

The unique identifier for the current workflow. All jobs that belong to the same pipeline share the same ID.

Pipeline is promotion​

  • Environment variable: SEMAPHORE_PIPELINE_PROMOTION
  • Example: true

Holds true when the pipeline was started due to a promotion. It is always false for the initial pipeline that starts the workflow.

Pipeline promoted by​

  • Environment variable: SEMAPHORE_PIPELINE_PROMOTED_BY
  • Example: torvalds

Determines the individual that promoted the pipeline. There are three possible cases:

  • Initial pipelines: the variable contains an empty string
  • Manual promotions: the GitHub or BitBucket username that manually promoted the pipeline
  • Auto-promotions: the value is auto-promotion

Pipeline is rerun​

  • Environment variable: SEMAPHORE_PIPELINE_RERUN
  • Example: true

Holds true when the pipeline is rerun by the user.

Project ID​

  • Environment variable: SEMAPHORE_PROJECT_ID
  • Example: 0dd982e8-32f5-4037-983e-4de01ac7fb1e

The project unique identifier that the job session belongs to. Semaphore automatically assigns unique IDs to every project.

Project name​

  • Environment variable: SEMAPHORE_PROJECT_NAME
  • Example: my-awesome-project

The name of the project that a job belongs to.

Workflow ID​

  • Environment variable: SEMAPHORE_WORKFLOW_ID
  • Example: 0dd982e8-32f5-4037-983e-4de01ac7fb1e

The workflow unique identifier. All jobs belonging to all pipelines in the workflow share this same ID. This includes the initial pipeline and all manually or auto-promoted pipelines in the same build.

Workflow number​

  • Environment variable: SEMAPHORE_WORKFLOW_NUMBER
  • Example: 42

This number is incremented every time the workflow runs. In other words, the number is incremented by one every time there is a Git push on any branch, every time there is a pull request, or a tag is pushed to the repository. It doesn't increment with debug jobs.

This number is available to all jobs in all pipelines belonging to the same workflow. This includes the initial pipeline and all manually or auto-promoted pipelines in the same build.

Workflow is rerun​

  • Environment variable: SEMAPHORE_WORKFLOW_RERUN
  • Example: true

Holds true if the workflow is a rerun of a previously-ran workflow.

Workflow triggered by​

  • Environment variable: SEMAPHORE_WORKFLOW_TRIGGERED_BY
  • Example: torvalds

Determines the GitHub or BitBucket username for the individual who promoted the pipeline.

Workflow is triggered by API​

  • Environment variable: SEMAPHORE_WORKFLOW_TRIGGERED_BY_API
  • Example: true

Holds true if the workflow was triggered using the Semaphore API

The variable is false if the workflow is triggered by a Git push, pull request, or via Tasks.

Workflow is triggered by hook​

  • Environment variable: SEMAPHORE_WORKFLOW_TRIGGERED_BY_HOOK
  • Example: true

Holds true if the workflow was triggered by a Git push to the repository. It's also true for Git tags and pull requests.

The variable is false when the workflow is triggered via the Semaphore API or using Tasks.

Workflow is triggered manually​

  • Environment variable: SEMAPHORE_WORKFLOW_TRIGGERED_BY_MANUAL_RUN
  • Example: true

Holds true if the workflow was triggered by a user through the Semaphore UI.

The variable is false when the workflow is triggered by Git push, pull request, Tasks, or the Semaphore API.

Workflow is triggered by task​

  • Environment variable: SEMAPHORE_WORKFLOW_TRIGGERED_BY_SCHEDULE
  • Example: true

Holds true if the workflow was triggered using Tasks.

Git repository variables​

These variables give Git-related information about the repository that is liked to the project the job is running.

Branch (upstream)​

  • Environment variable: SEMAPHORE_GIT_BRANCH
  • Example: main

The Git branch is used in the current job. On pull requests, the value is the name of the upstream branch targeted by the merge.

For example, if you create a branch called featureA and create a pull request to merge to main, then SEMAPHORE_GIT_BRANCH=main.

Working branch (downstream)​

  • Environment variable: SEMAPHORE_GIT_WORKING_BRANCH
  • Example: featureA

The name of the branch used in the current job. On pull request, this is the downstream branch that would be merged.

For example, if you create a branch called featureA and create a pull request to merge to main, then SEMAPHORE_GIT_WORKING_BRANCH=featureA.

note

The variable is missing when the workflow is triggered by pushing the Git tag.

Commit author​

  • Environment variable: SEMAPHORE_GIT_COMMIT_AUTHOR
  • Example: torvalds

The GitHub or Bitbucket username of the person who authored the revision.

Commit range​

  • Environment variable: SEMAPHORE_GIT_COMMIT_RANGE
  • Example: 5c84719708b9b649b9ef3b56af214f38cee6acde...92d87d5c0dd2dbb7a68ecb27df43d1b164fd3e30

The range of SHA commits that were included in a push or pull request.

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

Commit SHA​

  • Environment variable: SEMAPHORE_GIT_SHA
  • Example: 5c84719708b9b649b9ef3b56af214f38cee6acde

The current Git SHA revision of the code that the job is using.

Cache age​

  • Environment variable: SEMAPHORE_GIT_CACHE_AGE
  • Example: 259200

Used only when running checkout --use-cache. It specifies how often the Semaphore Git Cache is updated, expressed in seconds. The default is 259200 (3 days).

Cache keep​

  • Environment variable: SEMAPHORE_GIT_CACHE_KEEP
  • Example: 1

Used only when running checkout --use-cache. It how many copies of the repository should be maintained in the Semaphore Git Cache. Older copies are automatically deleted.

The default value is 0, which means that Semaphore maintains only 1 copy of the repository. If you set it to 1, Semaphore will maintain 2 copies of the repository.

Committer​

  • Environment variable: SEMAPHORE_GIT_COMMITTER
  • Example: torvalds

The GitHub or Bitbucket username of the person who authored the revision.

Depth​

  • Environment variable: SEMAPHORE_GIT_DEPTH
  • Example: 50

Holds the shallow clone depth level for the checkout command. The default value is 50.

Git provider​

  • Environment variable: SEMAPHORE_GIT_PROVIDER
  • Example: bitbucket, github

The Git provider the repository is hosted on. Possible values are bitbucket or github.

Git reference​

  • Environment variable: SEMAPHORE_GIT_REF
  • Example: refs/heads/master

The Git reference the commit that the job is using.

Git reference type​

  • Environment variable: SEMAPHORE_GIT_REF_TYPE
  • Example: branch, tag, or pull-request

The type of Git reference. Possible values are: branch, tag, or pull-request.

Git URL​

  • Environment variable: SEMAPHORE_GIT_URL
  • Example: http://git@github.com:semaphoreci/toolbox.git

The URL of the repository used in the current Semaphore project.

Pull request branch​

  • Environment variable: SEMAPHORE_GIT_PR_BRANCH
  • Example: featureA

The name of the Git branch from which the Pull Request originated (upstream)

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=pull-request

Pull request name​

  • Environment variable: SEMAPHORE_GIT_PR_NAME
  • Example: Update Readme.md

The name of the Pull Request that originated the workflow.

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=pull-request

Pull request number​

  • Environment variable: SEMAPHORE_GIT_PR_NUMBER
  • Example: 1

The number of the Pull Request.

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=pull-request

Pull request SHA​

  • Environment variable: SEMAPHORE_GIT_PR_SHA
  • Example: 5c84719708b9b649b9ef3b56af214f38cee6acd3

The Git SHA of the HEAD commit of the Pull Request.

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=pull-request

Pull request slug​

  • Environment variable: SEMAPHORE_GIT_PR_SLUG
  • Example: semaphoreci/semaphore

The name in the format owner_name/repo_name of the repository from which the Pull Request originated.

To distinguish workflows from original and forked repositories, you can compare SEMAPHORE_GIT_PR_SLUG and SEMAPHORE_GIT_REPO_SLUG environment variables.

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=pull-request

Repository directory​

  • Environment variable: SEMAPHORE_GIT_DIR
  • Example: src

The name of the directory that contains the files of the repository linked to the current Semaphore project.

Repository name​

  • Environment variable: SEMAPHORE_GIT_REPO_NAME
  • Example: my-awesome-app

The name of the Git repository name for the current Semaphore project.

Repository slug​

  • Environment variable: SEMAPHORE_GIT_REPO_SLUG
  • Example: semaphoreci/my-awesome-app

The repository name in the form owner/repo-name for the current Semaphore project.

Tag name​

  • Environment variable: SEMAPHORE_GIT_TAG_NAME
  • Example: v1.0.0

The name of the Git tag used in the current job.

note

Present only for builds where SEMAPHORE_GIT_REF_TYPE=tag.

After pipeline variables​

The following variables are available during after pipeline jobs.

Pipeline created at​

  • Environment variable: SEMAPHORE_PIPELINE_CREATED_AT
  • Example: 1632943641

The UNIX epoch timestamp when the pipeline was created.

Pipeline done at​

  • Environment variable: SEMAPHORE_PIPELINE_DONE_AT
  • Example: 1632943650

The UNIX epoch timestamp when the pipeline was finished.

Pipeline init duration​

  • Environment variable: SEMAPHORE_PIPELINE_INIT_DURATION
  • Example: 1

Duration of the pipeline initialization stage expressed in seconds.

Pipeline queueing duration​

  • Environment variable: SEMAPHORE_PIPELINE_QUEUEING_DURATION
  • Example: 1

The time that the pipeline spent in the queue is expressed in seconds.

Pipeline result​

  • Environment variable: SEMAPHORE_PIPELINE_RESULT
  • Example: failed, passed, canceled, stopped

Contains the result of the pipeline. Possible values are: failed, passed, canceled, stopped

Pipeline result reason​

  • Environment variable: SEMAPHORE_PIPELINE_RESULT_REASON
  • Example: test, malformed, stuck, internal, user, strategy, timeout

The reason for the pipeline result. Possible values are: test, malformed, stuck, internal, user, strategy, timeout

Pipeline running duration​

  • Environment variable: SEMAPHORE_PIPELINE_RUNNING_DURATION
  • Example: 12

The total pipeline execution time is expressed in seconds.

Pipeline started at​

  • Environment variable: SEMAPHORE_PIPELINE_STARTED_AT
  • Example: 1632943642

The UNIX epoch timestamp when the pipeline started running jobs.

Pipeline total duration​

  • Environment variable: SEMAPHORE_PIPELINE_TOTAL_DURATION
  • Example: 10

The total duration of the pipeline including queuing time expressed in seconds.

Cache variables​

These variables are used to access the cache.

Cache URL​

  • Environment variable: SEMAPHORE_CACHE_URL
  • Example: 94.130.158.146:29920

The IP address and the port number of the cache server.

Username​

  • Environment variable: SEMAPHORE_CACHE_USERNAME
  • Example: 0614ef08af7a408d8aae45b029ba3bb8

The username is used for connecting to the cache server.

Private Key Path​

  • Environment variable: SEMAPHORE_CACHE_PRIVATE_KEY_PATH
  • Example: /home/semaphore/.ssh/semaphore_cache_key

The path in the server to the SSH key file to access the cache server.

Semaphore Docker registry variables​

These variables can be used to access the Semaphore Docker registry.

Username​

  • Environment variable: SEMAPHORE_REGISTRY_USERNAME

Username to access the Semaphore Docker Registry.

Password​

  • Environment variable: SEMAPHORE_REGISTRY_PASSWORD

Password to access the Semaphore Docker Registry.

Registry URL​

  • Environment variable: SEMAPHORE_REGISTRY_URL

The URL to access the Semaphore Docker Registry.

Initialization job variables​

This section describes the special variables available during the initialization jobs and pre-flight checks in addition to the regular job environment variables explained above.

Input file​

  • Environment variable: INPUT_FILE
  • Default value: .semaphore/semaphore.yml

The path to the input pipeline file during the initialization job.

Output file​

  • Environment variable: OUTPUT_FILE
  • Default value: .semaphore/semaphore.yml.output.yml

The path to the output pipeline file during the initialization job. This file is used by Semaphore to lay out the jobs for the pipeline.

Logs file​

  • Environment variable: LOGS_FILE
  • Default value: .semaphore/semaphore.yml.logs.jsonl

The path to the log file during the initialization job.

See also​