"description":"`true` if `CI_COMMIT_MESSAGE` is truncated to the size specified in the `GITLAB_CI_MAX_COMMIT_MESSAGE_SIZE_IN_BYTES` system environment variable (default 100 KB) because the commit message is too long. Otherwise `false`. Introduced in GitLab 18.6."
},
{
"name":"CI_COMMIT_REF_NAME",
"description":"The branch or tag name for which project is built."
@@ -151,6 +155,10 @@
"name":"CI_ENVIRONMENT_ACTION",
"description":"The action annotation specified for this job's environment. Available if [`environment:action`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../yaml/_index.md#environmentaction) is set. Can be `start`, `prepare`, or `stop`."
},
{
"name":"CI_ENVIRONMENT_ID",
"description":"The ID of the environment for this job. Available if [`environment:name`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../yaml/_index.md#environmentname) is set."
},
{
"name":"CI_ENVIRONMENT_NAME",
"description":"The name of the environment for this job. Available if [`environment:name`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../yaml/_index.md#environmentname) is set."
@@ -185,7 +193,7 @@
},
{
"name":"CI_JOB_IMAGE",
"description":"The name of the Docker image running the job."
"description":"The name of the Docker image running the job. Only available when the job explicitly specifies a Docker image."
},
{
"name":"CI_JOB_MANUAL",
@@ -207,6 +215,10 @@
"name":"CI_JOB_STARTED_AT",
"description":"The date and time when a job started, in [ISO 8601](https://www.rfc-editor.org/rfc/rfc3339#appendix-A) format. For example, `2022-01-31T16:47:55Z`. [UTC by default](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../../administration/timezone.md)."
},
{
"name":"CI_JOB_STARTED_AT_SLUG",
"description":"`CI_JOB_STARTED_AT` in lowercase, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-`. No leading / trailing `-`. Suitable for use in Docker image tags and other identifiers. Introduced in GitLab 18.7."
},
{
"name":"CI_JOB_STATUS",
"description":"The status of the job as each runner stage is executed. Use with [`after_script`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../yaml/_index.md#after_script). Can be `success`, `failed`, or `canceled`."
@@ -277,7 +289,7 @@
},
{
"name":"CI_PIPELINE_TRIGGERED",
"description":"`true` if the job was [triggered](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../triggers/_index.md)."
"description":"`true` for pipelines [triggered with a trigger token](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../triggers/_index.md). For pipelines triggered with the [`trigger`](../yaml/_index.md#trigger) keyword, use [`CI_PIPELINE_SOURCE`](../jobs/job_rules.md#ci_pipeline_source-predefined-variable) instead."
},
{
"name":"CI_PIPELINE_URL",
@@ -293,7 +305,7 @@
},
{
"name":"CI_PROJECT_DIR",
"description":"The full path the repository is cloned to, and where the job runs from. If the GitLab Runner `builds_dir` parameter is set, this variable is set relative to the value of `builds_dir`. For more information, see the [Advanced GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section)."
"description":"The full path the repository is cloned to, and where the job runs from. If the GitLab Runner `builds_dir` parameter is set, this variable is set relative to the value of `builds_dir`. For more information, see the [Advanced GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration/#the-runners-section)."
},
{
"name":"CI_PROJECT_ID",
@@ -335,6 +347,10 @@
"name":"CI_PROJECT_TITLE",
"description":"The human-readable project name as displayed in the GitLab web interface."
},
{
"name":"CI_PROJECT_TOPICS",
"description":"A comma-separated, lowercase list of [topics](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../../user/project/project_topics.md) (limited to the first 20) assigned to the project. Introduced in GitLab 18.3"
},
{
"name":"CI_PROJECT_URL",
"description":"The HTTP(S) address of the project."
@@ -433,15 +449,15 @@
},
{
"name":"CI_SERVER_TLS_CA_FILE",
"description":"File containing the TLS CA certificate to verify the GitLab server when `tls-ca-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section)."
"description":"File containing the TLS CA certificate to verify the GitLab server when `tls-ca-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration/#the-runners-section)."
},
{
"name":"CI_SERVER_TLS_CERT_FILE",
"description":"File containing the TLS certificate to verify the GitLab server when `tls-cert-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section)."
"description":"File containing the TLS certificate to verify the GitLab server when `tls-cert-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration/#the-runners-section)."
},
{
"name":"CI_SERVER_TLS_KEY_FILE",
"description":"File containing the TLS key to verify the GitLab server when `tls-key-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section)."
"description":"File containing the TLS key to verify the GitLab server when `tls-key-file` set in [runner settings](https://docs.gitlab.com/runner/configuration/advanced-configuration/#the-runners-section)."
},
{
"name":"CI_SERVER_URL",
@@ -475,6 +491,18 @@
"name":"CI_TRIGGER_SHORT_TOKEN",
"description":"First 4 characters of the [trigger token](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../triggers/_index.md#create-a-pipeline-trigger-token) of the current job. Only available if the pipeline was [triggered with a trigger token](../triggers/_index.md). For example, for a trigger token of `glptt-1234567890abcdefghij`, `CI_TRIGGER_SHORT_TOKEN` would be `1234`. Introduced in GitLab 17.0. <!-- gitleaks:allow -->"
},
{
"name":"CI_UPSTREAM_JOB_ID",
"description":"ID of the upstream trigger job that triggered the current pipeline in a multi-project or parent-child pipeline. Introduced in GitLab 18.9."
},
{
"name":"CI_UPSTREAM_PIPELINE_ID",
"description":"ID of the upstream pipeline that triggered the current pipeline in a multi-project or parent-child pipeline. Introduced in GitLab 18.9."
},
{
"name":"CI_UPSTREAM_PROJECT_ID",
"description":"ID of the upstream project that triggered the current pipeline in a multi-project or parent-child pipeline. Introduced in GitLab 18.9."
},
{
"name":"GITLAB_CI",
"description":"Available for all jobs executed in CI/CD. `true` when available."
@@ -501,7 +529,7 @@
},
{
"name":"KUBECONFIG",
"description":"The path to the `kubeconfig` file with contexts for every shared agent connection. Only available when a [GitLab agent is authorized to access the project](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../../user/clusters/agent/ci_cd_workflow.md#authorize-agent-access)."
"description":"The path to the `kubeconfig` file with contexts for every shared agent connection. Only available when a [GitLab agent for Kubernetes is authorized to access the project](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/ci/variables/../../user/clusters/agent/ci_cd_workflow.md#authorize-agent-access)."
