Project values and variables

Cloud Server v4+

This page is a reference for all built-in values available for use in your CircleCI projects.

Built-in environment variables

The following built-in environment variables are available for CircleCI projects. Some environment variables are available for GitHub OAuth and Bitbucket Cloud projects that have been deprecated for GitLab, GitHub App and Bitbucket Data Center support. If you must continue to use those as environment variables in your GitLab pipelines, refer to the workaround described after the list below.

Environment variables are scoped at the job level and can be used within the context of a job. Environment variables do not exist at a pipeline level, therefore they cannot be used for any logic at the pipeline or workflow level.

You cannot use a built-in environment variable to define another environment variable. Instead, you must use a run step to export the new environment variables using BASH_ENV. For more details, see Setting an Environment Variable in a Shell Command.

Variable VCS Type Value Cloud Server

Variable	VCS	Type	Value	Server
`CI`	GitHub, Bitbucket, GitLab	Boolean	`true` (represents whether the current environment is a CI environment)
`CIRCLECI`	GitHub, Bitbucket, GitLab	Boolean	`true` (represents whether the current environment is a CircleCI environment)
`CIRCLE_BRANCH`	GitHub, Bitbucket, GitLab	String	The name of the Git branch currently being built.
`CIRCLE_BUILD_NUM`	GitHub, Bitbucket, GitLab	Integer	The number of the current job. Job numbers are unique for each job.
`CIRCLE_BUILD_URL`	GitHub, Bitbucket, GitLab	String	The URL for the current job on CircleCI.
`CIRCLE_JOB`	GitHub, Bitbucket, GitLab	String	The name of the current job.
`CIRCLE_NODE_INDEX`	GitHub, Bitbucket, GitLab	Integer	For jobs that run with parallelism enabled, this is the index of the current parallel run. The value ranges from 0 to (`CIRCLE_NODE_TOTAL` - 1)
`CIRCLE_NODE_TOTAL`	GitHub, Bitbucket, GitLab	Integer	For jobs that run with parallelism enabled, this is the number of parallel runs. This is equivalent to the value of `parallelism` in your config file.
`CIRCLE_OIDC_TOKEN`	GitHub, Bitbucket, GitLab	String	An OpenID Connect token signed by CircleCI which includes details about the current job.	from v4.4
`CIRCLE_OIDC_TOKEN_V2`	GitHub, Bitbucket, GitLab	String	An OpenID Connect token signed by CircleCI which includes details about the current job.	from v4.4
`CIRCLE_ORGANIZATION_ID`	GitHub, Bitbucket, GitLab	String	A unique identifier for the CircleCI organization.
`CIRCLE_PIPELINE_ID`	GitHub, Bitbucket, GitLab	String	A unique identifier for the current pipeline.
`CIRCLE_PR_NUMBER`	GitHub OAuth, Bitbucket Cloud	Integer	The number of the associated GitHub or Bitbucket pull request. Only available on forked PRs.
`CIRCLE_PR_REPONAME`	GitHub OAuth, Bitbucket Cloud	String	The name of the GitHub or Bitbucket repository where the pull request was created. Only available on forked PRs.
`CIRCLE_PR_USERNAME`	GitHub OAuth, Bitbucket Cloud	String	The GitHub or Bitbucket username of the user who created the pull request. Only available on forked PRs.
`CIRCLE_PREVIOUS_BUILD_NUM`	GitHub, Bitbucket, GitLab	Integer	The largest job number in a given branch that is less than the current job number. Note: The variable is not always set, and is not deterministic. It is also not set on runner executors. This variable will be deprecated and is not recommended for use.
`CIRCLE_PROJECT_ID`	GitHub, Bitbucket, GitLab	String	A unique identifier for the current project.
`CIRCLE_PROJECT_REPONAME`	GitHub, GitLab, Bitbucket	String	The name of the repository of the current project.
`CIRCLE_PROJECT_USERNAME`	GitHub, GitLab, Bitbucket	String	The GitHub or Bitbucket username of the current project.
`CIRCLE_PULL_REQUEST`	GitHub, Bitbucket Cloud	String	The URL of the associated pull request. If there are multiple associated pull requests, one URL is randomly chosen.
`CIRCLE_PULL_REQUESTS`	GitHub OAuth, Bitbucket Cloud	List	Comma-separated list of URLs of the current build’s associated pull requests.
`CIRCLE_REPOSITORY_URL`	GitHub OAuth, Bitbucket Cloud	String	The URL of your GitHub or Bitbucket repository.
`CIRCLE_SHA1`	GitHub, GitLab, Bitbucket	String	The SHA1 hash of the last commit of the current build.
`CIRCLE_TAG`	GitHub, Bitbucket, GitLab	String	The name of the git tag, if the current build is tagged. For more information, see the Git tag job execution section of the Workflows page.
`CIRCLE_USERNAME`	GitHub, Bitbucket, GitLab	String	The GitHub or Bitbucket username of the user who triggered the pipeline (only if the user has a CircleCI account).
`CIRCLE_WORKFLOW_ID`	GitHub, Bitbucket, GitLab	String	A unique identifier for the workflow instance of the current job. This identifier is the same for every job in a given workflow instance.
`CIRCLE_WORKFLOW_JOB_ID`	GitHub, Bitbucket, GitLab	String	A unique identifier for the current job.
`CIRCLE_WORKFLOW_WORKSPACE_ID`	GitHub, Bitbucket, GitLab	String	An identifier for the workspace of the current job. This identifier is the same for every job in a given workflow.
`CIRCLE_WORKING_DIRECTORY`	GitHub, Bitbucket, GitLab	String	The value of the `working_directory` key of the current job.
`CIRCLE_INTERNAL_TASK_DATA`	GitHub, Bitbucket, GitLab	String	Internal. A directory where internal data related to the job is stored. We do not document the contents of this directory; the data schema is subject to change.

CI

GitHub, Bitbucket, GitLab

Boolean

true (represents whether the current environment is a CI environment)

check icon

CIRCLECI

GitHub, Bitbucket, GitLab

Boolean

true (represents whether the current environment is a CircleCI environment)

check icon

CIRCLE_BRANCH

GitHub, Bitbucket, GitLab

String

The name of the Git branch currently being built.

check icon

CIRCLE_BUILD_NUM

GitHub, Bitbucket, GitLab

Integer

The number of the current job. Job numbers are unique for each job.

check icon

CIRCLE_BUILD_URL

GitHub, Bitbucket, GitLab

String

The URL for the current job on CircleCI.

check icon

CIRCLE_JOB

GitHub, Bitbucket, GitLab

String

The name of the current job.

check icon

CIRCLE_NODE_INDEX

GitHub, Bitbucket, GitLab

Integer

For jobs that run with parallelism enabled, this is the index of the current parallel run. The value ranges from 0 to (CIRCLE_NODE_TOTAL - 1)

check icon

CIRCLE_NODE_TOTAL

GitHub, Bitbucket, GitLab

Integer

For jobs that run with parallelism enabled, this is the number of parallel runs. This is equivalent to the value of parallelism in your config file.

check icon

CIRCLE_OIDC_TOKEN

GitHub, Bitbucket, GitLab

String

An OpenID Connect token signed by CircleCI which includes details about the current job.

check icon

check icon from v4.4

CIRCLE_OIDC_TOKEN_V2

GitHub, Bitbucket, GitLab

String

An OpenID Connect token signed by CircleCI which includes details about the current job.

check icon

check icon from v4.4

CIRCLE_ORGANIZATION_ID

GitHub, Bitbucket, GitLab

String

A unique identifier for the CircleCI organization.

check icon

CIRCLE_PIPELINE_ID

GitHub, Bitbucket, GitLab

String

A unique identifier for the current pipeline.

check icon

CIRCLE_PR_NUMBER

GitHub OAuth, Bitbucket Cloud

Integer

The number of the associated GitHub or Bitbucket pull request. Only available on forked PRs.

check icon

CIRCLE_PR_REPONAME

GitHub OAuth, Bitbucket Cloud

String

The name of the GitHub or Bitbucket repository where the pull request was created. Only available on forked PRs.

check icon

CIRCLE_PR_USERNAME

GitHub OAuth, Bitbucket Cloud

String

The GitHub or Bitbucket username of the user who created the pull request. Only available on forked PRs.

check icon

CIRCLE_PREVIOUS_BUILD_NUM

GitHub, Bitbucket, GitLab

Integer

The largest job number in a given branch that is less than the current job number. Note: The variable is not always set, and is not deterministic. It is also not set on runner executors. This variable will be deprecated and is not recommended for use.

check icon

CIRCLE_PROJECT_ID

GitHub, Bitbucket, GitLab

String

A unique identifier for the current project.

check icon

CIRCLE_PROJECT_REPONAME

GitHub, GitLab, Bitbucket

String

The name of the repository of the current project.

check icon

CIRCLE_PROJECT_USERNAME

GitHub, GitLab, Bitbucket

String

The GitHub or Bitbucket username of the current project.

check icon

CIRCLE_PULL_REQUEST

GitHub, Bitbucket Cloud

String

The URL of the associated pull request. If there are multiple associated pull requests, one URL is randomly chosen.

check icon

CIRCLE_PULL_REQUESTS

GitHub OAuth, Bitbucket Cloud

List

Comma-separated list of URLs of the current build’s associated pull requests.

check icon

CIRCLE_REPOSITORY_URL

GitHub OAuth, Bitbucket Cloud

String

The URL of your GitHub or Bitbucket repository.

check icon

CIRCLE_SHA1

GitHub, GitLab, Bitbucket

String

The SHA1 hash of the last commit of the current build.

check icon

CIRCLE_TAG

GitHub, Bitbucket, GitLab

String

The name of the git tag, if the current build is tagged. For more information, see the Git tag job execution section of the Workflows page.

check icon

CIRCLE_USERNAME

GitHub, Bitbucket, GitLab

String

The GitHub or Bitbucket username of the user who triggered the pipeline (only if the user has a CircleCI account).

check icon

CIRCLE_WORKFLOW_ID

GitHub, Bitbucket, GitLab

String

A unique identifier for the workflow instance of the current job. This identifier is the same for every job in a given workflow instance.

check icon

CIRCLE_WORKFLOW_JOB_ID

GitHub, Bitbucket, GitLab

String

A unique identifier for the current job.

check icon

CIRCLE_WORKFLOW_WORKSPACE_ID

GitHub, Bitbucket, GitLab

String

An identifier for the workspace of the current job. This identifier is the same for every job in a given workflow.

check icon

CIRCLE_WORKING_DIRECTORY

GitHub, Bitbucket, GitLab

String

The value of the working_directory key of the current job.

check icon

CIRCLE_INTERNAL_TASK_DATA

GitHub, Bitbucket, GitLab

String

Internal. A directory where internal data related to the job is stored. We do not document the contents of this directory; the data schema is subject to change.

check icon

If you must use the environment variables that are deprecated for GitLab SaaS in your GitLab pipelines, you can recreate this functionality using pipeline values in your configuration file. The following example shows how to set an environment variable CIRCLE_PROJECT_REPONAME using the environment key and populating it with the pipeline.trigger_parameters.gitlab.repo_name value:

build:
  docker:
    - image: cimg/node:17.0
      auth:
        username: mydockerhub-user
        password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
  environment:
    CIRCLE_PROJECT_REPONAME: << pipeline.trigger_parameters.gitlab.repo_name >>
  steps:
    - run: echo $CIRCLE_PROJECT_REPONAME

Pipeline values

Pipeline values are available to all pipeline configurations and can be used without previous declaration. Pipeline values are scoped at the pipeline level. They are interpolated at compilation time, not workflow/job runtime.

The pipeline values available to you depend on your pipeline/integration type, as shown in the "Source" column of the table below.

Variable Source Type Value Cloud Server

Variable	Source	Type	Value	Cloud	Server
`pipeline.id`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	A globally unique id representing for the pipeline.	Yes	Yes
`pipeline.number`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	Integer	A project unique integer id for the pipeline.	Yes	Yes
`pipeline.definition.id`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab (except schedule workflows)	String	The unique ID of the pipeline definition.	Yes	Yes
`pipeline.config.file_path`	GitHub App	String	The file path to the CircleCI configuration file used by the pipeline.	Yes	No
`pipeline.config.ref`	GitHub App	String	The full Git ref used to fetch the CircleCI configuration file, for example `refs/heads/main` or `refs/tags/v1.0`.	Yes	No
`pipeline.config.repository.name`	GitHub App	String	The name of the repository containing the CircleCI configuration file, in the format `owner/repo-name`.	Yes	No
`pipeline.config.repository.url`	GitHub App	String	The URL of the repository containing the CircleCI configuration file.	Yes	No
`pipeline.config.sha`	GitHub App	String	The long (40-character) git SHA of the commit used to fetch the CircleCI configuration file.	Yes	No
`pipeline.project.git_url`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The URL where the current project is hosted. For example, `https://github.com/circleci/circleci-docs`.	Yes	Yes
`pipeline.project.type`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The lower-case name of the VCS provider, for example, `github`, `bitbucket`.	Yes	Yes
`pipeline.trigger.received_at`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The timestamp of when the pipeline was triggered, in ISO 8601 format.	Yes	Yes
`pipeline.git.tag`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The name of the git tag that was pushed to trigger the pipeline. If the pipeline was not triggered by a tag, then this is the empty string.	Yes	Yes
`pipeline.git.branch`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The name of the git branch that was pushed to trigger the pipeline.	Yes	Yes
`pipeline.git.branch.is_default`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	Boolean	Whether the branch the pipeline was triggered on is the default branch.	Yes	Yes (>= v4.7)
`pipeline.git.revision`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The long (40-character) git SHA that is being built.	Yes	Yes
`pipeline.git.base_revision`	GitHub OAuth Bitbucket Cloud	String	The long (40-character) git SHA of the build prior to the one being built. Note: While in most cases `pipeline.git.base_revision` will be the SHA of the pipeline that ran before your currently running pipeline, there are some caveats. When the build is the first build for a branch, the variable will not be present. In addition, if the build was triggered via the API, the variable will not be present.	Yes	Yes
`pipeline.trigger_source`	GitHub App GitHub OAuth Bitbucket Cloud Bitbucket Data Center GitLab	String	The source that triggers the pipeline, current values are `webhook`, `api`, `scheduled_pipeline`.	Yes	Yes
`pipeline.schedule.name`	GitHub OAuth Bitbucket Cloud	String	The name of the schedule trigger if the pipeline was triggered via schedule. The value will be empty string if the pipeline is triggered by other sources.	Yes	Yes
`pipeline.schedule.id`	GitHub OAuth Bitbucket Cloud	String	The unique ID of the schedule if the pipeline was triggered via schedule trigger. Value will be empty string if the pipeline is triggered by other sources.	Yes	Yes
`pipeline.trigger_parameters.circleci.trigger_type`	GitHub App GitLab	String	GitHub App, GitLab	Yes	No
`pipeline.trigger_parameters.circleci.event_time` Deprecated: Use `pipeline.trigger.received_at` instead.	GitHub App GitLab	String	Timestamp CircleCI received the event	Yes	No
`pipeline.trigger_parameters.circleci.event_type`	GitHub App GitLab	String	GitHub App: push GitLab: push, merge request	Yes	No
`pipeline.trigger_parameters.gitlab.type`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.gitlab.ref`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.ref`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.checkout_sha`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.checkout_sha`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.user_id`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.user_id`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.user_name`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.user_name`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.user_username`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.user_username`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.user_avatar`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.user_avatar`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.repo_name`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.repo_name`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.repo_url`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.repo_url`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.web_url`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.web_url`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_sha`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.commit_sha`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_title`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.commit_title`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_message`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.commit_message`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_timestamp`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.commit_timestamp`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_author_name`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.commit_author_name`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.commit_author_email`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.gitlab.branch`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.github_app.branch`	GitHub App		See GitHub documentation for webhook events and payloads.	Yes	No
`pipeline.trigger_parameters.gitlab.default_branch`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.gitlab.x_gitlab_event_id`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.gitlab.is_fork_merge_request`	GitLab		See GitLab documentation for webhooks and webhook events.	Yes	No
`pipeline.trigger_parameters.webhook.body`	Custom webhook	String	The body of the payload that was sent with a Custom Webhook.	Yes	No
`pipeline.event.name`	GitHub App	String	The name of the event that triggered the pipeline. Possible values: `custom_webhook`, `api`, `push`, `pull_request`.	Yes	No
`pipeline.event.action`	GitHub App	String	The action associated with the event. This value is always the same as `pipeline.event.name`, except for GitHub Events that have an `action` property, for example `pull_request`. Possible values: `custom_webhook`, `api`, `push`, `opened`, `synchronize`, `reopened`, `closed`, `ready_for_review`, `labeled`. Read more about GitHub Trigger Event Options.	Yes	No
`pipeline.event.github.after`	GitHub App	String	The SHA of the most recent commit on the branch after the push. Corresponds to the `after` field on the GitHub push event payload. Only populated for push events.	Yes	No
`pipeline.event.github.head_commit.url`	GitHub App	String	The URL of the most recent commit on the branch. Corresponds to the `head_commit.url` field on the GitHub push event payload. Only populated for push events.	Yes	No
`pipeline.event.github.ref`	GitHub App	String	The full Git ref that was pushed. Corresponds to the `ref` field on the GitHub push event payload. Only populated for push events.	Yes	No
`pipeline.event.context.github.pr_url`	GitHub App	String	The URL of the associated GitHub pull request, if one exists. If there are multiple associated pull requests, one URL is randomly chosen. This value matches environment variable CIRCLE_PULL_REQUEST.	Yes	No
`pipeline.event.github.pull_request.base.ref`	GitHub App	String	The name of the base (or target) branch of the pull request. Corresponds to the `pull_request.base.ref` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.base.sha`	GitHub App	String	The SHA of the base branch of the pull request. Corresponds to the `pull_request.base.sha` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.head.ref`	GitHub App	String	The name of the head branch of the pull request. Corresponds to the `pull_request.head.ref` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.head.sha`	GitHub App	String	The SHA of the head branch of the pull request. Corresponds to the `pull_request.head.sha` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.draft`	GitHub App	Boolean	A boolean value indicating whether the pull request is a draft. Corresponds to the `pull_request.draft` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.title`	GitHub App	String	The title of the pull request. Corresponds to the `pull_request.title` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.number`	GitHub App	Integer	The numeric identifier of the pull request. Corresponds to the `pull_request.number` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.merged`	GitHub App	Boolean	A boolean value indicating whether the pull request has been merged. Corresponds to the `pull_request.merged` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.pull_request.url`	GitHub App	String	The URL of the pull request. Corresponds to the `pull_request.url` field on the GitHub pull request event payload. Only populated for pull request events.	Yes	No
`pipeline.event.github.label.name`	GitHub App	String	The name of the label applied to the pull request. Corresponds to the `label.name` field on the GitHub pull request event payload. Only populated for pull request events with the `labeled` action.	Yes	No
`pipeline.event.github.comment.body`	GitHub App	String	The body of the comment that triggered the pipeline, with leading and trailing whitespace removed. Corresponds to the `comment.body` field on `issue_comment` and `pull_request_review_comment` GitHub event payloads. Only populated for pipelines triggered by a PR comment.	Yes	No
`pipeline.event.github.sender.type`	GitHub App	String	The type of GitHub user that triggered the event. Corresponds to the `sender.type` field on GitHub event payloads. Possible values are `User`, `Organization`, and `Bot`.	Yes	No
`pipeline.event.github.sender.avatar_url`	GitHub App	String	The avatar URL of the GitHub user who triggered the event. Corresponds to the `sender.avatar_url` field on GitHub event payloads.	Yes	No
`pipeline.event.github.sender.login`	GitHub App	String	The login name of the GitHub user who triggered the event. Corresponds to the `sender.login` field on GitHub event payloads.	Yes	No
`pipeline.event.github.repository.name`	GitHub App	String	The name of the repository that triggered the event, without the owner prefix. Corresponds to the `repository.name` field on repository-related GitHub event payloads.	Yes	No
`pipeline.event.github.repository.owner.login`	GitHub App	String	The login name of the repository owner. Corresponds to the `repository.owner.login` field on repository-related GitHub event payloads.	Yes	No
`pipeline.event.github.repository.url`	GitHub App	String	The URL of the repository that triggered the event. Corresponds to the `repository.url` field on repository-related GitHub event payloads.	Yes	No
`pipeline.deploy.component_name`	GitHub App	String	The name of the component that will be rolled back or deployed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No
`pipeline.deploy.environment_name`	GitHub App	String	The name of the environment in which the rollback or deploy will be performed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No
`pipeline.deploy.target_version`	GitHub App	String	The version of the component that needs to be rolled back to or deployed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No
`pipeline.deploy.current_version`	GitHub App	String	The current version of the component that is going to be rolled back or deployed. Can be used to verify that the status of the component matches expectations. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No
`pipeline.deploy.namespace`	GitHub App	String	The namespace of the environment that was deployed to. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No
`pipeline.deploy.reason`	GitHub App	String	The reason for the deployment or rollback. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.	Yes	No

pipeline.id

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

A globally unique id representing for the pipeline.

Yes

pipeline.number

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

Integer

A project unique integer id for the pipeline.

Yes

pipeline.definition.id

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab
(except schedule workflows)

String

The unique ID of the pipeline definition.

Yes

pipeline.config.file_path

GitHub App

String

The file path to the CircleCI configuration file used by the pipeline.

Yes

pipeline.config.ref

GitHub App

String

The full Git ref used to fetch the CircleCI configuration file, for example refs/heads/main or refs/tags/v1.0.

Yes

pipeline.config.repository.name

GitHub App

String

The name of the repository containing the CircleCI configuration file, in the format owner/repo-name.

Yes

pipeline.config.repository.url

GitHub App

String

The URL of the repository containing the CircleCI configuration file.

Yes

pipeline.config.sha

GitHub App

String

The long (40-character) git SHA of the commit used to fetch the CircleCI configuration file.

Yes

pipeline.project.git_url

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The URL where the current project is hosted. For example, https://github.com/circleci/circleci-docs.

Yes

pipeline.project.type

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The lower-case name of the VCS provider, for example, github, bitbucket.

Yes

pipeline.trigger.received_at

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The timestamp of when the pipeline was triggered, in ISO 8601 format.

Yes

pipeline.git.tag

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The name of the git tag that was pushed to trigger the pipeline. If the pipeline was not triggered by a tag, then this is the empty string.

Yes

pipeline.git.branch

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The name of the git branch that was pushed to trigger the pipeline.

Yes

pipeline.git.branch.is_default

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

Boolean

Whether the branch the pipeline was triggered on is the default branch.

Yes

Yes (>= v4.7)

pipeline.git.revision

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The long (40-character) git SHA that is being built.

Yes

pipeline.git.base_revision

GitHub OAuth
Bitbucket Cloud

String

The long (40-character) git SHA of the build prior to the one being built. Note: While in most cases pipeline.git.base_revision will be the SHA of the pipeline that ran before your currently running pipeline, there are some caveats. When the build is the first build for a branch, the variable will not be present. In addition, if the build was triggered via the API, the variable will not be present.

Yes

pipeline.trigger_source

GitHub App
GitHub OAuth
Bitbucket Cloud
Bitbucket Data Center
GitLab

String

The source that triggers the pipeline, current values are webhook, api, scheduled_pipeline.

Yes

pipeline.schedule.name

GitHub OAuth
Bitbucket Cloud

String

The name of the schedule trigger if the pipeline was triggered via schedule. The value will be empty string if the pipeline is triggered by other sources.

Yes

pipeline.schedule.id

GitHub OAuth
Bitbucket Cloud

String

The unique ID of the schedule if the pipeline was triggered via schedule trigger. Value will be empty string if the pipeline is triggered by other sources.

Yes

pipeline.trigger_parameters.circleci.trigger_type

GitHub App
GitLab

String

GitHub App, GitLab

Yes

warning icon pipeline.trigger_parameters.circleci.event_time
Deprecated: Use pipeline.trigger.received_at instead.

GitHub App
GitLab

String

Timestamp CircleCI received the event

Yes

pipeline.trigger_parameters.circleci.event_type

GitHub App
GitLab

String

GitHub App: push
GitLab: push, merge request

Yes

pipeline.trigger_parameters.gitlab.type

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.gitlab.ref

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.ref

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.checkout_sha

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.checkout_sha

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.user_id

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.user_id

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.user_name

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.user_name

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.user_username

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.user_username

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.user_avatar

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.user_avatar

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.repo_name

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.repo_name

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.repo_url

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.repo_url

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.web_url

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.web_url

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_sha

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.commit_sha

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_title

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.commit_title

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_message

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.commit_message

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_timestamp

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.commit_timestamp

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_author_name

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.commit_author_name

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.commit_author_email

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.gitlab.branch

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.github_app.branch

GitHub App

See GitHub documentation for webhook events and payloads.

Yes

pipeline.trigger_parameters.gitlab.default_branch

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.gitlab.x_gitlab_event_id

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.gitlab.is_fork_merge_request

GitLab

See GitLab documentation for webhooks and webhook events.

Yes

pipeline.trigger_parameters.webhook.body

Custom webhook

String

The body of the payload that was sent with a Custom Webhook.

Yes

pipeline.event.name

GitHub App

String

The name of the event that triggered the pipeline. Possible values: custom_webhook, api, push, pull_request.

Yes

pipeline.event.action

GitHub App

String

The action associated with the event. This value is always the same as pipeline.event.name, except for GitHub Events that have an action property, for example pull_request. Possible values: custom_webhook, api, push, opened, synchronize, reopened, closed, ready_for_review, labeled. Read more about GitHub Trigger Event Options.

Yes

pipeline.event.github.after

GitHub App

String

The SHA of the most recent commit on the branch after the push. Corresponds to the after field on the GitHub push event payload. Only populated for push events.

Yes

pipeline.event.github.head_commit.url

GitHub App

String

The URL of the most recent commit on the branch. Corresponds to the head_commit.url field on the GitHub push event payload. Only populated for push events.

Yes

pipeline.event.github.ref

GitHub App

String

The full Git ref that was pushed. Corresponds to the ref field on the GitHub push event payload. Only populated for push events.

Yes

pipeline.event.context.github.pr_url

GitHub App

String

The URL of the associated GitHub pull request, if one exists. If there are multiple associated pull requests, one URL is randomly chosen. This value matches environment variable CIRCLE_PULL_REQUEST.

Yes

pipeline.event.github.pull_request.base.ref

GitHub App

String

The name of the base (or target) branch of the pull request. Corresponds to the pull_request.base.ref field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.base.sha

GitHub App

String

The SHA of the base branch of the pull request. Corresponds to the pull_request.base.sha field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.head.ref

GitHub App

String

The name of the head branch of the pull request. Corresponds to the pull_request.head.ref field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.head.sha

GitHub App

String

The SHA of the head branch of the pull request. Corresponds to the pull_request.head.sha field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.draft

GitHub App

Boolean

A boolean value indicating whether the pull request is a draft. Corresponds to the pull_request.draft field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.title

GitHub App

String

The title of the pull request. Corresponds to the pull_request.title field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.number

GitHub App

Integer

The numeric identifier of the pull request. Corresponds to the pull_request.number field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.merged

GitHub App

Boolean

A boolean value indicating whether the pull request has been merged. Corresponds to the pull_request.merged field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.pull_request.url

GitHub App

String

The URL of the pull request. Corresponds to the pull_request.url field on the GitHub pull request event payload. Only populated for pull request events.

Yes

pipeline.event.github.label.name

GitHub App

String

The name of the label applied to the pull request. Corresponds to the label.name field on the GitHub pull request event payload. Only populated for pull request events with the labeled action.

Yes

pipeline.event.github.comment.body

GitHub App

String

The body of the comment that triggered the pipeline, with leading and trailing whitespace removed. Corresponds to the comment.body field on issue_comment and pull_request_review_comment GitHub event payloads. Only populated for pipelines triggered by a PR comment.

Yes

pipeline.event.github.sender.type

GitHub App

String

The type of GitHub user that triggered the event. Corresponds to the sender.type field on GitHub event payloads. Possible values are User, Organization, and Bot.

Yes

pipeline.event.github.sender.avatar_url

GitHub App

String

The avatar URL of the GitHub user who triggered the event. Corresponds to the sender.avatar_url field on GitHub event payloads.

Yes

pipeline.event.github.sender.login

GitHub App

String

The login name of the GitHub user who triggered the event. Corresponds to the sender.login field on GitHub event payloads.

Yes

pipeline.event.github.repository.name

GitHub App

String

The name of the repository that triggered the event, without the owner prefix. Corresponds to the repository.name field on repository-related GitHub event payloads.

Yes

pipeline.event.github.repository.owner.login

GitHub App

String

The login name of the repository owner. Corresponds to the repository.owner.login field on repository-related GitHub event payloads.

Yes

pipeline.event.github.repository.url

GitHub App

String

The URL of the repository that triggered the event. Corresponds to the repository.url field on repository-related GitHub event payloads.

Yes

pipeline.deploy.component_name

GitHub App

String

The name of the component that will be rolled back or deployed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

pipeline.deploy.environment_name

GitHub App

String

The name of the environment in which the rollback or deploy will be performed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

pipeline.deploy.target_version

GitHub App

String

The version of the component that needs to be rolled back to or deployed. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

pipeline.deploy.current_version

GitHub App

String

The current version of the component that is going to be rolled back or deployed. Can be used to verify that the status of the component matches expectations. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

pipeline.deploy.namespace

GitHub App

String

The namespace of the environment that was deployed to. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

pipeline.deploy.reason

GitHub App

String

The reason for the deployment or rollback. Only for use with rollbacks and deploys. See Set up a Rollback Pipeline and Set up a Deploy Pipeline guides.

Yes

For example:

version: 2.1

jobs:
  build:
    docker:
      - image: cimg/node:20.3.0
    environment:
      CIRCLE_COMPARE_URL: << pipeline.project.git_url >>/compare/<< pipeline.git.base_revision >>..<<pipeline.git.revision>>
    working_directory: ~/main
    steps:
      - run: echo "This is pipeline ID << pipeline.id >>"
      - run: echo $CIRCLE_COMPARE_URL

When using the above method to set the variables in the environment key, note that if the pipeline variable is empty it will be set to <nil>. If you need an empty string instead, set the variable in a shell command.

[path]

[title]

Project values and variables

Built-in environment variables

Pipeline values