Project values and variables

Cloud

Server v4.x

Server v3.x

Built-in environment variables

The following built-in environment variables are available for CircleCI projects. A few environment variables are available for GitHub and Bitbucket projects that have been deprecated for GitLab SaaS 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. They can be used within the context of a job but 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
`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.
`CIRCLE_OIDC_TOKEN_V2`	GitHub, Bitbucket, GitLab	String	An OpenID Connect token signed by CircleCI which includes details about the current job.
`CIRCLE_PR_NUMBER`	GitHub, Bitbucket	Integer	The number of the associated GitHub or Bitbucket pull request. Only available on forked PRs.
`CIRCLE_PR_REPONAME`	GitHub, Bitbucket	String	The name of the GitHub or Bitbucket repository where the pull request was created. Only available on forked PRs.
`CIRCLE_PR_USERNAME`	GitHub, Bitbucket	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 is likely to be deprecated, and CircleCI recommends users to avoid using it.
`CIRCLE_PROJECT_REPONAME`	GitHub, Bitbucket	String	The name of the repository of the current project.
`CIRCLE_PROJECT_USERNAME`	GitHub, Bitbucket	String	The GitHub or Bitbucket username of the current project.
`CIRCLE_PULL_REQUEST`	GitHub, Bitbucket	String	The URL of the associated pull request. If there are multiple associated pull requests, one URL is randomly chosen.
`CIRCLE_PULL_REQUESTS`	GitHub, Bitbucket	List	Comma-separated list of URLs of the current build’s associated pull requests.
`CIRCLE_REPOSITORY_URL`	GitHub, Bitbucket	String	The URL of your GitHub or Bitbucket repository.
`CIRCLE_SHA1`	GitHub, Bitbucket	String	The SHA1 hash of the last commit of the current build.
`CIRCLE_TAG`	GitHub, Bitbucket	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.

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.

Variable	VCS	Type	Value
`pipeline.id`	GitHub, Bitbucket	String	A globally unique id representing for the pipeline.
`pipeline.number`	GitHub, Bitbucket	Integer	A project unique integer id for the pipeline.
`pipeline.project.git_url`	GitHub, Bitbucket	String	The URL where the current project is hosted. For example, `https://github.com/circleci/circleci-docs`.
`pipeline.project.type`	GitHub, Bitbucket	String	The lower-case name of the VCS provider, for example, “github”, “bitbucket”.
`pipeline.git.tag`	GitHub, Bitbucket	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.
`pipeline.git.branch`	GitHub, Bitbucket	String	The name of the git branch that was pushed to trigger the pipeline.
`pipeline.git.revision`	GitHub, Bitbucket	String	The long (40-character) git SHA that is being built.
`pipeline.git.base_revision`	GitHub, Bitbucket	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.
`pipeline.in_setup`	GitHub, Bitbucket	Boolean	True if the pipeline is in the setup phase, for example, running a setup workflow.
`pipeline.trigger_source`	GitHub, Bitbucket	String	The source that triggers the pipeline, current values are `webhook`, `api`, `scheduled_pipeline`.
`pipeline.schedule.name`	GitHub, Bitbucket	String	The name of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources.
`pipeline.schedule.id`	GitHub, Bitbucket	String	The unique id of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources.
`pipeline.trigger_parameters.circleci.trigger_id`	GitLab		ID of the trigger that received the event
`pipeline.trigger_parameters.circleci.config_source_id`	GitLab		ID for the configuration source
`pipeline.trigger_parameters.circleci.trigger_type`	GitLab		GitLab
`pipeline.trigger_parameters.circleci.event_time`	GitLab		Timestamp CircleCI received the event
`pipeline.trigger_parameters.circleci.event_type`	GitLab		Push, pull request, manual, etc.
`pipeline.trigger_parameters.circleci.project_id`	GitLab		CircleCI project ID
`pipeline.trigger_parameters.circleci.actor_id`	GitLab		CircleCI user ID
`pipeline.trigger_parameters.gitlab.type`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.project_id`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.ref`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.checkout_sha`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.user_id`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.user_name`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.user_username`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.user_avatar`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.repo_name`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.repo_url`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.web_url`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_sha`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_title`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_message`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_timestamp`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_author_name`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.commit_author_email`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.total_commits_count`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.branch`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.default_branch`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.x_gitlab_event_id`	GitLab		See Gitlab documentation for webhooks and webhook events.
`pipeline.trigger_parameters.gitlab.is_fork_merge_request`	GitLab		See Gitlab documentation for webhooks and webhook events.

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.

Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Suggest an edit to this page (please read the contributing guide first).
To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Project values and variables

On This Page

Built-in environment variables

Pipeline values

Help make this document better

Need support?