Skip to content

GitLab

Predefined environment variables reference

For an introduction on this subject, read through the getting started with environment variables document.

Some of the predefined environment variables are available only if a minimum version of GitLab Runner is used. Consult the table below to find the version of GitLab Runner that's required.

You can add a command to your .gitlab-ci.yml file to output the values of all variables available for a job.

Kubernetes-specific environment variables are detailed in the Kubernetes deployment variables section.

Variable GitLab Runner Description
CHAT_CHANNEL 10.6 all Source chat channel which triggered the ChatOps command.
CHAT_INPUT 10.6 all Additional arguments passed in the ChatOps command.
CI all 0.4 Mark that job is executed in CI environment.
CI_API_V4_URL 11.7 all The GitLab API v4 root URL.
CI_BUILDS_DIR all 11.10 Top-level directory where builds are executed.
CI_COMMIT_BEFORE_SHA 11.2 all The previous latest commit present on a branch. Is always 0000000000000000000000000000000000000000 in pipelines for merge requests.
CI_COMMIT_DESCRIPTION 10.8 all The description of the commit: the message without first line, if the title is shorter than 100 characters; full message in other case.
CI_COMMIT_MESSAGE 10.8 all The full commit message.
CI_COMMIT_REF_NAME 9.0 all The branch or tag name for which project is built.
CI_COMMIT_REF_PROTECTED 11.11 all true if the job is running on a protected reference, false if not.
CI_COMMIT_REF_SLUG 9.0 all $CI_COMMIT_REF_NAME in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
CI_COMMIT_SHA 9.0 all The commit revision for which project is built.
CI_COMMIT_SHORT_SHA 11.7 all The first eight characters of CI_COMMIT_SHA.
CI_COMMIT_BRANCH 12.6 0.5 The commit branch name. Present in branch pipelines, including pipelines for the default branch. Not present in merge request pipelines or tag pipelines.
CI_COMMIT_TAG 9.0 0.5 The commit tag name. Present only when building tags.
CI_COMMIT_TITLE 10.8 all The title of the commit - the full first line of the message.
CI_COMMIT_TIMESTAMP 13.4 all The timestamp of the commit in the ISO 8601 format.
CI_CONCURRENT_ID all 11.10 Unique ID of build execution in a single executor.
CI_CONCURRENT_PROJECT_ID all 11.10 Unique ID of build execution in a single executor and project.
CI_CONFIG_PATH 9.4 0.5 The path to CI configuration file. Defaults to .gitlab-ci.yml.
CI_DEBUG_TRACE all 1.7 Whether debug logging (tracing) is enabled.
CI_DEFAULT_BRANCH 12.4 all The name of the default branch for the project.
CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX 13.7 all The image prefix for pulling images through the Dependency Proxy.
CI_DEPENDENCY_PROXY_SERVER 13.7 all The server for logging in to the Dependency Proxy. This is equivalent to $CI_SERVER_HOST:$CI_SERVER_PORT.
CI_DEPENDENCY_PROXY_PASSWORD 13.7 all The password to use to pull images through the Dependency Proxy.
CI_DEPENDENCY_PROXY_USER 13.7 all The username to use to pull images through the Dependency Proxy.
CI_DEPLOY_FREEZE 13.2 all Included with the value true if the pipeline runs during a deploy freeze window.
CI_DEPLOY_PASSWORD 10.8 all Authentication password of the GitLab Deploy Token, only present if the Project has one related.
CI_DEPLOY_USER 10.8 all Authentication username of the GitLab Deploy Token, only present if the Project has one related.
CI_DISPOSABLE_ENVIRONMENT all 10.1 Marks that the job is executed in a disposable environment (something that is created only for this job and disposed of/destroyed after the execution - all executors except shell and ssh). If the environment is disposable, it is set to true, otherwise it is not defined at all.
CI_ENVIRONMENT_NAME 8.15 all The name of the environment for this job. Only present if environment:name is set.
CI_ENVIRONMENT_SLUG 8.15 all A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, and so on. Only present if environment:name is set.
CI_ENVIRONMENT_URL 9.3 all The URL of the environment for this job. Only present if environment:url is set.
CI_EXTERNAL_PULL_REQUEST_IID 12.3 all Pull Request ID from GitHub if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_SOURCE_REPOSITORY 13.3 all The source repository name of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_TARGET_REPOSITORY 13.3 all The target repository name of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME 12.3 all The source branch name of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA 12.3 all The HEAD SHA of the source branch of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME 12.3 all The target branch name of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA 12.3 all The HEAD SHA of the target branch of the pull request if the pipelines are for external pull requests. Available only if only: [external_pull_requests] or rules syntax is used and the pull request is open.
CI_HAS_OPEN_REQUIREMENTS 13.1 all Included with the value true only if the pipeline's project has any open requirements. Not included if there are no open requirements for the pipeline's project.
CI_OPEN_MERGE_REQUESTS 13.8 all Available in branch and merge request pipelines. Contains a comma-separated list of up to four merge requests that use the current branch and project as the merge request source. For example gitlab-org/gitlab!333,gitlab-org/gitlab-foss!11.
CI_JOB_ID 9.0 all The unique ID of the current job that GitLab CI/CD uses internally.
CI_JOB_IMAGE 12.9 12.9 The name of the image running the CI job.
CI_JOB_MANUAL 8.12 all The flag to indicate that job was manually started.
CI_JOB_NAME 9.0 0.5 The name of the job as defined in .gitlab-ci.yml.
CI_JOB_STAGE 9.0 0.5 The name of the stage as defined in .gitlab-ci.yml.
CI_JOB_STATUS all 13.5 The state of the job as each runner stage is executed. Use with after_script where CI_JOB_STATUS can be either: success, failed or canceled.
CI_JOB_TOKEN 9.0 1.2 Token used for authenticating with a few API endpoints and downloading dependent repositories. The token is valid as long as the job is running.
CI_JOB_JWT 12.10 all RS256 JSON web token that can be used for authenticating with third party systems that support JWT authentication, for example HashiCorp's Vault.
CI_JOB_URL 11.1 0.5 Job details URL.
CI_KUBERNETES_ACTIVE 13.0 all Included with the value true only if the pipeline has a Kubernetes cluster available for deployments. Not included if no cluster is available. Can be used as an alternative to only:kubernetes/except:kubernetes with rules:if.
CI_MERGE_REQUEST_ASSIGNEES 11.9 all Comma-separated list of username(s) of assignee(s) for the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_ID 11.6 all The instance-level ID of the merge request. Only available if the pipelines are for merge requests and the merge request is created. This is a unique ID across all projects on GitLab.
CI_MERGE_REQUEST_IID 11.6 all The project-level IID (internal ID) of the merge request. Only available If the pipelines are for merge requests and the merge request is created. This ID is unique for the current project.
CI_MERGE_REQUEST_LABELS 11.9 all Comma-separated label names of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_MILESTONE 11.9 all The milestone title of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_PROJECT_ID 11.6 all The ID of the project of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_PROJECT_PATH 11.6 all The path of the project of the merge request if the pipelines are for merge requests (for example namespace/awesome-project). Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_PROJECT_URL 11.6 all The URL of the project of the merge request if the pipelines are for merge requests (for example http://192.168.10.15:3000/namespace/awesome-project). Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_REF_PATH 11.6 all The ref path of the merge request if the pipelines are for merge requests. (for example refs/merge-requests/1/head). Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_SOURCE_BRANCH_NAME 11.6 all The source branch name of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_SOURCE_BRANCH_SHA 11.9 all The HEAD SHA of the source branch of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used, the merge request is created, and the pipeline is a merged result pipeline. (PREMIUM)
CI_MERGE_REQUEST_SOURCE_PROJECT_ID 11.6 all The ID of the source project of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_SOURCE_PROJECT_PATH 11.6 all The path of the source project of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_SOURCE_PROJECT_URL 11.6 all The URL of the source project of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_TARGET_BRANCH_NAME 11.6 all The target branch name of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_TARGET_BRANCH_SHA 11.9 all The HEAD SHA of the target branch of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used, the merge request is created, and the pipeline is a merged result pipeline. (PREMIUM)
CI_MERGE_REQUEST_TITLE 11.9 all The title of the merge request if the pipelines are for merge requests. Available only if only: [merge_requests] or rules syntax is used and the merge request is created.
CI_MERGE_REQUEST_EVENT_TYPE 12.3 all The event type of the merge request, if the pipelines are for merge requests. Can be detached, merged_result or merge_train.
CI_MERGE_REQUEST_DIFF_ID 13.7 all The version of the merge request diff, if the pipelines are for merge requests.
CI_MERGE_REQUEST_DIFF_BASE_SHA 13.7 all The base SHA of the merge request diff, if the pipelines are for merge requests.
CI_NODE_INDEX 11.5 all Index of the job in the job set. If the job is not parallelized, this variable is not set.
CI_NODE_TOTAL 11.5 all Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to 1.
CI_PAGES_DOMAIN 11.8 all The configured domain that hosts GitLab Pages.
CI_PAGES_URL 11.8 all URL to GitLab Pages-built pages. Always belongs to a subdomain of CI_PAGES_DOMAIN.
CI_PIPELINE_ID 8.10 all The instance-level ID of the current pipeline. This is a unique ID across all projects on GitLab.
CI_PIPELINE_IID 11.0 all The project-level IID (internal ID) of the current pipeline. This ID is unique for the current project.
CI_PIPELINE_SOURCE 10.0 all Indicates how the pipeline was triggered. Possible options are: push, web, schedule, api, external, chat, webide, merge_request_event, external_pull_request_event, parent_pipeline, trigger, or pipeline. For pipelines created before GitLab 9.5, this is displayed as unknown.
CI_PIPELINE_TRIGGERED all all The flag to indicate that job was triggered.
CI_PIPELINE_URL 11.1 0.5 Pipeline details URL.
CI_PROJECT_CONFIG_PATH 13.8 all The CI configuration path for the project.
CI_PROJECT_DIR all all The full path where the repository is cloned and where the job is run. If the GitLab Runner builds_dir parameter is set, this variable is set relative to the value of builds_dir. For more information, see Advanced configuration for GitLab Runner.
CI_PROJECT_ID all all The unique ID of the current project that GitLab CI/CD uses internally.
CI_PROJECT_NAME 8.10 0.5 The name of the directory for the project that is being built. For example, if the project URL is gitlab.example.com/group-name/project-1, the CI_PROJECT_NAME would be project-1.
CI_PROJECT_NAMESPACE 8.10 0.5 The project namespace (username or group name) that is being built.
CI_PROJECT_ROOT_NAMESPACE 13.2 0.5 The root project namespace (username or group name) that is being built. For example, if CI_PROJECT_NAMESPACE is root-group/child-group/grandchild-group, CI_PROJECT_ROOT_NAMESPACE would be root-group.
CI_PROJECT_PATH 8.10 0.5 The namespace with project name.
CI_PROJECT_PATH_SLUG 9.3 all $CI_PROJECT_PATH in lowercase and with everything except 0-9 and a-z replaced with -. Use in URLs and domain names.
CI_PROJECT_REPOSITORY_LANGUAGES 12.3 all Comma-separated, lowercase list of the languages used in the repository (for example ruby,javascript,html,css).
CI_PROJECT_TITLE 12.4 all The human-readable project name as displayed in the GitLab web interface.
CI_PROJECT_URL 8.10 0.5 The HTTP(S) address to access project.
CI_PROJECT_VISIBILITY 10.3 all The project visibility (internal, private, public).
CI_REGISTRY 8.10 0.5 If the Container Registry is enabled it returns the address of the GitLab Container Registry. This variable includes a :port value if one has been specified in the registry configuration.
CI_REGISTRY_IMAGE 8.10 0.5 If the Container Registry is enabled for the project it returns the address of the registry tied to the specific project.
CI_REGISTRY_PASSWORD 9.0 all The password to use to push containers to the GitLab Container Registry, for the current project.
CI_REGISTRY_USER 9.0 all The username to use to push containers to the GitLab Container Registry, for the current project.
CI_REPOSITORY_URL 9.0 all The URL to clone the Git repository.
CI_RUNNER_DESCRIPTION 8.10 0.5 The description of the runner as saved in GitLab.
CI_RUNNER_EXECUTABLE_ARCH all 10.6 The OS/architecture of the GitLab Runner executable (note that this is not necessarily the same as the environment of the executor).
CI_RUNNER_ID 8.10 0.5 The unique ID of runner being used.
CI_RUNNER_REVISION all 10.6 GitLab Runner revision that is executing the current job.
CI_RUNNER_SHORT_TOKEN all 12.3 First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID.
CI_RUNNER_TAGS 8.10 0.5 The defined runner tags.
CI_RUNNER_VERSION all 10.6 GitLab Runner version that is executing the current job.
CI_SERVER all all Mark that job is executed in CI environment.
CI_SERVER_URL 12.7 all The base URL of the GitLab instance, including protocol and port (like https://gitlab.example.com:8080).
CI_SERVER_HOST 12.1 all Host component of the GitLab instance URL, without protocol and port (like gitlab.example.com).
CI_SERVER_PORT 12.8 all Port component of the GitLab instance URL, without host and protocol (like 3000).
CI_SERVER_PROTOCOL 12.8 all Protocol component of the GitLab instance URL, without host and port (like https).
CI_SERVER_NAME all all The name of CI server that is used to coordinate jobs.
CI_SERVER_REVISION all all GitLab revision that is used to schedule jobs.
CI_SERVER_VERSION all all GitLab version that is used to schedule jobs.
CI_SERVER_VERSION_MAJOR 11.4 all GitLab version major component.
CI_SERVER_VERSION_MINOR 11.4 all GitLab version minor component.
CI_SERVER_VERSION_PATCH 11.4 all GitLab version patch component.
CI_SHARED_ENVIRONMENT all 10.1 Marks that the job is executed in a shared environment (something that is persisted across CI invocations like shell or ssh executor). If the environment is shared, it is set to true, otherwise it is not defined at all.
GITLAB_CI all all Mark that job is executed in GitLab CI/CD environment.
GITLAB_FEATURES 10.6 all The comma separated list of licensed features available for your instance and plan.
GITLAB_USER_EMAIL 8.12 all The email of the user who started the job.
GITLAB_USER_ID 8.12 all The ID of the user who started the job.
GITLAB_USER_LOGIN 10.0 all The login username of the user who started the job.
GITLAB_USER_NAME 10.0 all The real name of the user who started the job.