2016-11-25 13:41:16 +00:00
# Variables
2016-04-17 18:08:02 +00:00
2017-02-13 16:59:57 +00:00
When receiving a job from GitLab CI, the [Runner] prepares the build environment.
2016-12-05 21:46:13 +00:00
It starts by setting a list of **predefined variables** (environment variables)
2016-11-25 13:41:16 +00:00
and a list of **user-defined variables** .
2015-08-26 01:42:46 +00:00
2016-12-05 21:46:13 +00:00
## Priority of variables
2016-11-25 13:41:16 +00:00
2016-12-05 21:46:13 +00:00
The variables can be overwritten and they take precedence over each other in
this order:
2017-07-01 10:23:41 +00:00
1. [Trigger variables][triggers] or [scheduled pipeline variables ](../../user/project/pipelines/schedules.md#making-use-of-scheduled-pipeline-variables ) (take precedence over all)
2017-07-03 14:43:06 +00:00
1. Project-level [secret variables ](#secret-variables ) or [protected secret variables ](#protected-secret-variables )
1. Group-level [secret variables ](#secret-variables ) or [protected secret variables ](#protected-secret-variables )
2016-12-05 21:46:13 +00:00
1. YAML-defined [job-level variables ](../yaml/README.md#job-variables )
1. YAML-defined [global variables ](../yaml/README.md#variables )
2016-12-16 12:24:03 +00:00
1. [Deployment variables ](#deployment-variables )
2016-12-05 21:46:13 +00:00
1. [Predefined variables ](#predefined-variables-environment-variables ) (are the
lowest in the chain)
2015-08-26 01:42:46 +00:00
2016-12-05 21:55:57 +00:00
For example, if you define `API_TOKEN=secure` as a secret variable and
2016-12-05 21:46:13 +00:00
`API_TOKEN=yaml` in your `.gitlab-ci.yml` , the `API_TOKEN` will take the value
2016-12-05 21:55:57 +00:00
`secure` as the secret variables are higher in the chain.
2015-08-26 01:42:46 +00:00
2016-11-25 13:41:16 +00:00
## Predefined variables (Environment variables)
2015-08-26 01:42:46 +00:00
2016-12-05 21:46:13 +00:00
Some of the predefined environment variables are available only if a minimum
version of [GitLab Runner][runner] is used. Consult the table below to find the
version of Runner required.
2015-08-26 01:42:46 +00:00
2017-03-09 09:19:37 +00:00
>**Note:**
Starting with GitLab 9.0, we have deprecated some variables. Read the
[9.0 Renaming ](#9-0-renaming ) section to find out their replacements. **You are
strongly advised to use the new variables as we will remove the old ones in
future GitLab releases.**
| Variable | GitLab | Runner | Description |
|-------------------------------- |--------|--------|-------------|
| **CI** | all | 0.4 | Mark that job is executed in CI environment |
| **CI_COMMIT_REF_NAME** | 9.0 | all | The branch or tag name for which project is built |
2017-07-05 16:21:19 +00:00
| **CI_COMMIT_REF_SLUG** | 9.0 | all | `$CI_COMMIT_REF_NAME` lowercased, 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. |
2017-03-09 09:19:37 +00:00
| **CI_COMMIT_SHA** | 9.0 | all | The commit revision for which project is built |
| **CI_COMMIT_TAG** | 9.0 | 0.5 | The commit tag name. Present only when building tags. |
2017-07-03 18:00:50 +00:00
| **CI_CONFIG_PATH** | 9.4 | 0.5 | The path to CI config file. Defaults to `.gitlab-ci.yml` |
2017-03-09 09:19:37 +00:00
| **CI_DEBUG_TRACE** | all | 1.7 | Whether [debug tracing ](#debug-tracing ) is enabled |
| **CI_ENVIRONMENT_NAME** | 8.15 | all | The name of the environment for this job |
| **CI_ENVIRONMENT_SLUG** | 8.15 | all | A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, etc. |
2017-05-25 14:58:51 +00:00
| **CI_ENVIRONMENT_URL** | 9.3 | all | The URL of the environment for this job |
2017-03-09 09:19:37 +00:00
| **CI_JOB_ID** | 9.0 | all | The unique id of the current job that GitLab CI uses internally |
| **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_TOKEN** | 9.0 | 1.2 | Token used for authenticating with the GitLab Container Registry |
| **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_ID** | 8.10 | 0.5 | The unique id of runner being used |
| **CI_RUNNER_TAGS** | 8.10 | 0.5 | The defined runner tags |
| **CI_PIPELINE_ID** | 8.10 | 0.5 | The unique id of the current pipeline that GitLab CI uses internally |
| **CI_PIPELINE_TRIGGERED** | all | all | The flag to indicate that job was [triggered] |
2017-08-23 08:45:46 +00:00
| **CI_PIPELINE_SOURCE** | 10.0 | all | The source for this pipeline, one of: push, web, trigger, schedule, api, external. Pipelines created before 9.5 will have unknown as source |
2017-03-09 09:19:37 +00:00
| **CI_PROJECT_DIR** | all | all | The full path where the repository is cloned and where the job is run |
| **CI_PROJECT_ID** | all | all | The unique id of the current project that GitLab CI uses internally |
2017-06-01 05:04:16 +00:00
| **CI_PROJECT_NAME** | 8.10 | 0.5 | The project name that is currently being built (actually it is project folder name) |
2017-03-09 09:19:37 +00:00
| **CI_PROJECT_NAMESPACE** | 8.10 | 0.5 | The project namespace (username or groupname) that is currently being built |
| **CI_PROJECT_PATH** | 8.10 | 0.5 | The namespace with project name |
2017-06-01 05:04:16 +00:00
| **CI_PROJECT_PATH_SLUG** | 9.3 | all | `$CI_PROJECT_PATH` lowercased and with everything except `0-9` and `a-z` replaced with `-` . Use in URLs and domain names. |
2017-03-09 09:19:37 +00:00
| **CI_PROJECT_URL** | 8.10 | 0.5 | The HTTP address to access project |
| **CI_REGISTRY** | 8.10 | 0.5 | If the Container Registry is enabled it returns the address of GitLab's Container Registry |
| **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 |
| **CI_REGISTRY_USER** | 9.0 | all | The username to use to push containers to the GitLab Container Registry |
| **CI_SERVER** | all | all | Mark that job is executed in CI environment |
| **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 |
| **ARTIFACT_DOWNLOAD_ATTEMPTS** | 8.15 | 1.9 | Number of attempts to download artifacts running a job |
| **GET_SOURCES_ATTEMPTS** | 8.15 | 1.9 | Number of attempts to fetch sources running a job |
| **GITLAB_CI** | all | all | Mark that job is executed in GitLab CI environment |
| **GITLAB_USER_ID** | 8.12 | all | The id of the user who started the job |
| **GITLAB_USER_EMAIL** | 8.12 | all | The email of the user who started the job |
2017-08-25 04:01:55 +00:00
| **GITLAB_USER_LOGIN** | 10.0 | all | The login username of the user who started the job |
2017-08-25 04:01:01 +00:00
| **GITLAB_USER_NAME** | 10.0 | all | The real name of the user who started the job |
2017-03-09 09:19:37 +00:00
| **RESTORE_CACHE_ATTEMPTS** | 8.15 | 1.9 | Number of attempts to restore the cache running a job |
2015-08-26 01:42:46 +00:00
2017-03-07 09:06:53 +00:00
## 9.0 Renaming
To follow conventions of naming across GitLab, and to futher move away from the
`build` term and toward `job` CI variables have been renamed for the 9.0
release.
2017-08-24 14:40:38 +00:00
>**Note:**
Starting with GitLab 9.0, we have deprecated the `$CI_BUILD_*` variables. **You are
strongly advised to use the new variables as we will remove the old ones in
future GitLab releases.**
2017-03-09 09:19:37 +00:00
| 8.x name | 9.0+ name |
| --------------------- |------------------------ |
| `CI_BUILD_ID` | `CI_JOB_ID` |
| `CI_BUILD_REF` | `CI_COMMIT_SHA` |
| `CI_BUILD_TAG` | `CI_COMMIT_TAG` |
| `CI_BUILD_REF_NAME` | `CI_COMMIT_REF_NAME` |
| `CI_BUILD_REF_SLUG` | `CI_COMMIT_REF_SLUG` |
| `CI_BUILD_NAME` | `CI_JOB_NAME` |
| `CI_BUILD_STAGE` | `CI_JOB_STAGE` |
2017-03-09 12:06:11 +00:00
| `CI_BUILD_REPO` | `CI_REPOSITORY_URL` |
2017-03-09 09:19:37 +00:00
| `CI_BUILD_TRIGGERED` | `CI_PIPELINE_TRIGGERED` |
| `CI_BUILD_MANUAL` | `CI_JOB_MANUAL` |
| `CI_BUILD_TOKEN` | `CI_JOB_TOKEN` |
2017-03-07 09:06:53 +00:00
2016-12-05 21:46:13 +00:00
## `.gitlab-ci.yaml` defined variables
2016-11-25 13:41:16 +00:00
>**Note:**
This feature requires GitLab Runner 0.5.0 or higher and GitLab CI 7.14 or higher.
2015-08-26 01:42:46 +00:00
2016-11-25 13:41:16 +00:00
GitLab CI allows you to add to `.gitlab-ci.yml` variables that are set in the
build environment. The variables are hence saved in the repository, and they
are meant to store non-sensitive project configuration, e.g., `RAILS_ENV` or
`DATABASE_URL` .
For example, if you set the variable below globally (not inside a job), it will
be used in all executed commands and scripts:
2015-08-26 01:42:46 +00:00
```yaml
variables:
DATABASE_URL: "postgres://postgres@postgres/my_database"
```
2016-11-25 13:41:16 +00:00
The YAML-defined variables are also set to all created
[service containers ](../docker/using_docker_images.md ), thus allowing to fine
tune them.
Variables can be defined at a global level, but also at a job level. To turn off
2017-06-06 07:55:24 +00:00
global defined variables in your job, define an empty hash:
2016-11-25 13:41:16 +00:00
```yaml
job_name:
2017-06-04 06:14:42 +00:00
variables: {}
2016-11-25 13:41:16 +00:00
```
2017-02-28 23:49:28 +00:00
You are able to use other variables inside your variable definition (or escape them with `$$` ):
```yaml
variables:
LS_CMD: 'ls $FLAGS $$TMP_DIR'
FLAGS: '-al'
script:
- 'eval $LS_CMD' # will execute 'ls -al $TMP_DIR'
```
2016-12-05 21:55:57 +00:00
## Secret variables
2015-08-26 01:42:46 +00:00
2016-11-25 13:41:16 +00:00
>**Notes:**
- This feature requires GitLab Runner 0.4.0 or higher.
2017-07-03 14:43:06 +00:00
- Group-level secret variables added in GitLab 9.4.
2016-12-05 21:55:57 +00:00
- Be aware that secret variables are not masked, and their values can be shown
2017-02-13 16:59:57 +00:00
in the job logs if explicitly asked to do so. If your project is public or
2016-11-25 13:41:16 +00:00
internal, you can set the pipelines private from your project's Pipelines
settings. Follow the discussion in issue [#13784][ce-13784] for masking the
2016-12-05 21:55:57 +00:00
secret variables.
2015-08-26 01:42:46 +00:00
2017-09-14 15:59:35 +00:00
GitLab CI allows you to define per-project or per-group secret variables
that are set in the pipeline environment. The secret variables are stored out of
the repository (not in `.gitlab-ci.yml` ) and are securely passed to GitLab Runner
making them available during a pipeline run. It's the recommended method to
use for storing things like passwords, SSH keys and credentials.
2016-04-16 19:17:05 +00:00
2017-07-03 14:43:06 +00:00
Project-level secret variables can be added by going to your project's
2017-09-14 15:59:35 +00:00
**Settings > CI/CD**, then finding the section called **Secret variables** .
2015-08-26 01:42:46 +00:00
2017-07-03 14:43:06 +00:00
Likewise, group-level secret variables can be added by going to your group's
2017-09-14 15:59:35 +00:00
**Settings > CI/CD**, then finding the section called **Secret variables** .
2017-07-03 14:43:06 +00:00
Any variables of [subgroups] will be inherited recursively.
2015-08-26 01:42:46 +00:00
2017-05-03 18:51:55 +00:00
Once you set them, they will be available for all subsequent pipelines. You can also
[protect your variables ](#protected-secret-variables ).
2017-05-25 12:29:12 +00:00
2017-07-06 07:45:38 +00:00
### Protected secret variables
2017-05-25 12:29:12 +00:00
>**Notes:**
2017-06-01 13:22:38 +00:00
This feature requires GitLab 9.3 or higher.
2017-05-25 12:29:12 +00:00
2017-05-31 14:45:51 +00:00
Secret variables could be protected. Whenever a secret variable is
2017-05-25 12:29:12 +00:00
protected, it would only be securely passed to pipelines running on the
2017-05-31 14:45:51 +00:00
[protected branches] or [protected tags]. The other pipelines would not get any
2017-05-25 12:29:12 +00:00
protected variables.
Protected variables can be added by going to your project's
2017-09-14 15:59:35 +00:00
**Settings > CI/CD**, then finding the section called
**Secret variables**, and check "Protected".
2017-05-25 12:29:12 +00:00
Once you set them, they will be available for all subsequent pipelines.
2016-10-05 16:40:13 +00:00
2016-12-16 12:24:03 +00:00
## Deployment variables
>**Note:**
This feature requires GitLab CI 8.15 or higher.
2017-02-03 18:41:35 +00:00
[Project services ](../../user/project/integrations/project_services.md ) that are
2016-12-16 12:24:03 +00:00
responsible for deployment configuration may define their own variables that
are set in the build environment. These variables are only defined for
2017-02-13 16:59:57 +00:00
[deployment jobs ](../environments.md ). Please consult the documentation of
2016-12-16 12:24:03 +00:00
the project services that you are using to learn which variables they define.
An example project service that defines deployment variables is
2017-02-03 18:41:35 +00:00
[Kubernetes Service ](../../user/project/integrations/kubernetes.md ).
2016-12-16 12:24:03 +00:00
2016-11-25 13:41:16 +00:00
## Debug tracing
> Introduced in GitLab Runner 1.7.
>
2016-10-05 16:40:13 +00:00
> **WARNING:** Enabling debug tracing can have severe security implications. The
2016-12-05 21:55:57 +00:00
output **will** contain the content of all your secret variables and any other
2016-10-05 16:40:13 +00:00
secrets! The output **will** be uploaded to the GitLab server and made visible
2017-02-13 16:59:57 +00:00
in job traces!
2016-10-05 16:40:13 +00:00
By default, GitLab Runner hides most of the details of what it is doing when
2017-02-13 16:59:57 +00:00
processing a job. This behaviour keeps job traces short, and prevents secrets
2016-10-05 16:40:13 +00:00
from being leaked into the trace unless your script writes them to the screen.
If a job isn't working as expected, this can make the problem difficult to
investigate; in these cases, you can enable debug tracing in `.gitlab-ci.yml` .
Available on GitLab Runner v1.7+, this feature enables the shell's execution
2017-02-13 16:59:57 +00:00
trace, resulting in a verbose job trace listing all commands that were run,
2016-10-05 16:40:13 +00:00
variables that were set, etc.
2017-02-13 16:59:57 +00:00
Before enabling this, you should ensure jobs are visible to
2016-12-05 21:46:13 +00:00
[team members only ](../../user/permissions.md#project-features ). You should
2017-02-13 16:59:57 +00:00
also [erase ](../pipelines.md#seeing-build-status ) all generated job traces
2016-10-05 16:40:13 +00:00
before making them visible again.
To enable debug traces, set the `CI_DEBUG_TRACE` variable to `true` :
```yaml
2016-11-25 13:41:16 +00:00
job_name:
2016-10-05 16:40:13 +00:00
variables:
CI_DEBUG_TRACE: "true"
```
2016-12-05 21:46:13 +00:00
Example truncated output with debug trace set to true:
```bash
...
export CI_SERVER_TLS_CA_FILE="/builds/gitlab-examples/ci-debug-trace.tmp/CI_SERVER_TLS_CA_FILE"
if [[ -d "/builds/gitlab-examples/ci-debug-trace/.git" ]]; then
echo $'\''\x1b[32;1mFetching changes...\x1b[0;m'\''
$'\''cd'\'' "/builds/gitlab-examples/ci-debug-trace"
$'\''git'\'' "config" "fetch.recurseSubmodules" "false"
$'\''rm'\'' "-f" ".git/index.lock"
$'\''git'\'' "clean" "-ffdx"
$'\''git'\'' "reset" "--hard"
$'\''git'\'' "remote" "set-url" "origin" "https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@example.com/gitlab-examples/ci-debug-trace.git"
$'\''git'\'' "fetch" "origin" "--prune" "+refs/heads/*:refs/remotes/origin/*" "+refs/tags/*:refs/tags/*"
else
$'\''mkdir'\'' "-p" "/builds/gitlab-examples/ci-debug-trace.tmp/git-template"
$'\''rm'\'' "-r" "-f" "/builds/gitlab-examples/ci-debug-trace"
$'\''git'\'' "config" "-f" "/builds/gitlab-examples/ci-debug-trace.tmp/git-template/config" "fetch.recurseSubmodules" "false"
echo $'\''\x1b[32;1mCloning repository...\x1b[0;m'\''
$'\''git'\'' "clone" "--no-checkout" "https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@example.com/gitlab-examples/ci-debug-trace.git" "/builds/gitlab-examples/ci-debug-trace" "--template" "/builds/gitlab-examples/ci-debug-trace.tmp/git-template"
$'\''cd'\'' "/builds/gitlab-examples/ci-debug-trace"
fi
echo $'\''\x1b[32;1mChecking out dd648b2e as master...\x1b[0;m'\''
$'\''git'\'' "checkout" "-f" "-q" "dd648b2e48ce6518303b0bb580b2ee32fadaf045"
'
+++ hostname
++ echo 'Running on runner-8a2f473d-project-1796893-concurrent-0 via runner-8a2f473d-machine-1480971377-317a7d0f-digital-ocean-4gb...'
Running on runner-8a2f473d-project-1796893-concurrent-0 via runner-8a2f473d-machine-1480971377-317a7d0f-digital-ocean-4gb...
++ export CI=true
++ CI=true
++ export CI_DEBUG_TRACE=false
++ CI_DEBUG_TRACE=false
2017-03-16 23:27:42 +00:00
++ export CI_COMMIT_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ CI_COMMIT_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
2017-03-10 10:20:08 +00:00
++ export CI_COMMIT_BEFORE_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ CI_COMMIT_BEFORE_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ export CI_COMMIT_REF_NAME=master
++ CI_COMMIT_REF_NAME=master
++ export CI_JOB_ID=7046507
++ CI_JOB_ID=7046507
++ export CI_REPOSITORY_URL=https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@example.com/gitlab-examples/ci-debug-trace.git
++ CI_REPOSITORY_URL=https://gitlab-ci-token:xxxxxxxxxxxxxxxxxxxx@example.com/gitlab-examples/ci-debug-trace.git
++ export CI_JOB_TOKEN=xxxxxxxxxxxxxxxxxxxx
++ CI_JOB_TOKEN=xxxxxxxxxxxxxxxxxxxx
2016-12-05 21:46:13 +00:00
++ export CI_PROJECT_ID=1796893
++ CI_PROJECT_ID=1796893
++ export CI_PROJECT_DIR=/builds/gitlab-examples/ci-debug-trace
++ CI_PROJECT_DIR=/builds/gitlab-examples/ci-debug-trace
++ export CI_SERVER=yes
++ CI_SERVER=yes
++ export 'CI_SERVER_NAME=GitLab CI'
++ CI_SERVER_NAME='GitLab CI'
++ export CI_SERVER_VERSION=
++ CI_SERVER_VERSION=
++ export CI_SERVER_REVISION=
++ CI_SERVER_REVISION=
++ export GITLAB_CI=true
++ GITLAB_CI=true
++ export CI=true
++ CI=true
++ export GITLAB_CI=true
++ GITLAB_CI=true
2017-03-10 10:20:08 +00:00
++ export CI_JOB_ID=7046507
++ CI_JOB_ID=7046507
++ export CI_JOB_TOKEN=xxxxxxxxxxxxxxxxxxxx
++ CI_JOB_TOKEN=xxxxxxxxxxxxxxxxxxxx
++ export CI_COMMIT_REF=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ CI_COMMIT_REF=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ export CI_COMMIT_BEFORE_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ CI_COMMIT_BEFORE_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ export CI_COMMIT_REF_NAME=master
++ CI_COMMIT_REF_NAME=master
++ export CI_COMMIT_NAME=debug_trace
++ CI_JOB_NAME=debug_trace
++ export CI_JOB_STAGE=test
++ CI_JOB_STAGE=test
2016-12-05 21:46:13 +00:00
++ export CI_SERVER_NAME=GitLab
++ CI_SERVER_NAME=GitLab
++ export CI_SERVER_VERSION=8.14.3-ee
++ CI_SERVER_VERSION=8.14.3-ee
++ export CI_SERVER_REVISION=82823
++ CI_SERVER_REVISION=82823
++ export CI_PROJECT_ID=17893
++ CI_PROJECT_ID=17893
++ export CI_PROJECT_NAME=ci-debug-trace
++ CI_PROJECT_NAME=ci-debug-trace
++ export CI_PROJECT_PATH=gitlab-examples/ci-debug-trace
++ CI_PROJECT_PATH=gitlab-examples/ci-debug-trace
++ export CI_PROJECT_NAMESPACE=gitlab-examples
++ CI_PROJECT_NAMESPACE=gitlab-examples
++ export CI_PROJECT_URL=https://example.com/gitlab-examples/ci-debug-trace
++ CI_PROJECT_URL=https://example.com/gitlab-examples/ci-debug-trace
++ export CI_PIPELINE_ID=52666
++ CI_PIPELINE_ID=52666
++ export CI_RUNNER_ID=1337
++ CI_RUNNER_ID=1337
++ export CI_RUNNER_DESCRIPTION=shared-runners-manager-1.example.com
++ CI_RUNNER_DESCRIPTION=shared-runners-manager-1.example.com
2017-02-24 12:18:07 +00:00
++ export 'CI_RUNNER_TAGS=shared, docker, linux, ruby, mysql, postgres, mongo'
++ CI_RUNNER_TAGS='shared, docker, linux, ruby, mysql, postgres, mongo'
2016-12-05 21:46:13 +00:00
++ export CI_REGISTRY=registry.example.com
++ CI_REGISTRY=registry.example.com
++ export CI_DEBUG_TRACE=true
++ CI_DEBUG_TRACE=true
++ export GITLAB_USER_ID=42
++ GITLAB_USER_ID=42
++ export GITLAB_USER_EMAIL=user@example.com
2017-04-07 18:51:38 +00:00
++ GITLAB_USER_EMAIL=user@example.com
2016-12-05 21:46:13 +00:00
++ export VERY_SECURE_VARIABLE=imaverysecurevariable
++ VERY_SECURE_VARIABLE=imaverysecurevariable
++ mkdir -p /builds/gitlab-examples/ci-debug-trace.tmp
++ echo -n '-----BEGIN CERTIFICATE-----
MIIFQzCCBCugAwIBAgIRAL/ElDjuf15xwja1ZnCocWAwDQYJKoZIhvcNAQELBQAw'
...
```
2016-10-05 16:40:13 +00:00
2016-11-25 13:41:16 +00:00
## Using the CI variables in your job scripts
2015-08-26 01:42:46 +00:00
2016-11-25 13:41:16 +00:00
All variables are set as environment variables in the build environment, and
they are accessible with normal methods that are used to access such variables.
2017-02-13 16:59:57 +00:00
In most cases `bash` or `sh` is used to execute the job script.
2015-08-26 01:42:46 +00:00
2017-04-14 23:01:52 +00:00
To access environment variables, use the syntax for your Runner's [shell][shellexecutors].
2016-02-09 00:08:49 +00:00
2017-04-14 23:01:52 +00:00
| Shell | Usage |
|----------------------|-----------------|
| bash/sh | `$variable` |
| windows batch | `%variable%` |
| PowerShell | `$env:variable` |
To access environment variables in bash, prefix the variable name with (`$`):
```yaml
2015-08-26 01:42:46 +00:00
job_name:
script:
2017-04-27 14:12:29 +00:00
- echo $CI_JOB_ID
2015-08-26 01:42:46 +00:00
```
2017-04-14 23:01:52 +00:00
To access environment variables in **Windows Batch** , surround the variable
with (`%`):
```yaml
job_name:
script:
- echo %CI_JOB_ID%
```
To access environment variables in a **Windows PowerShell** environment, prefix
the variable name with (`$env:`):
```yaml
job_name:
script:
- echo $env:CI_JOB_ID
```
2016-11-25 13:41:16 +00:00
You can also list all environment variables with the `export` command,
2016-12-05 21:55:57 +00:00
but be aware that this will also expose the values of all the secret variables
2017-02-13 16:59:57 +00:00
you set, in the job log:
2016-11-25 13:41:16 +00:00
2017-04-14 23:01:52 +00:00
```yaml
2015-08-26 01:42:46 +00:00
job_name:
script:
- export
```
2016-03-01 07:57:09 +00:00
2017-03-09 12:06:11 +00:00
Example values:
```bash
export CI_JOB_ID="50"
export CI_COMMIT_SHA="1ecfd275763eff1d6b4844ea3168962458c9f27a"
export CI_COMMIT_REF_NAME="master"
2017-04-03 12:19:11 +00:00
export CI_REPOSITORY_URL="https://gitlab-ci-token:abcde-1234ABCD5678ef@example.com/gitlab-org/gitlab-ce.git"
2017-03-09 12:06:11 +00:00
export CI_COMMIT_TAG="1.0.0"
export CI_JOB_NAME="spec:other"
export CI_JOB_STAGE="test"
export CI_JOB_MANUAL="true"
export CI_JOB_TRIGGERED="true"
export CI_JOB_TOKEN="abcde-1234ABCD5678ef"
export CI_PIPELINE_ID="1000"
export CI_PROJECT_ID="34"
export CI_PROJECT_DIR="/builds/gitlab-org/gitlab-ce"
export CI_PROJECT_NAME="gitlab-ce"
export CI_PROJECT_NAMESPACE="gitlab-org"
export CI_PROJECT_PATH="gitlab-org/gitlab-ce"
export CI_PROJECT_URL="https://example.com/gitlab-org/gitlab-ce"
export CI_REGISTRY="registry.example.com"
export CI_REGISTRY_IMAGE="registry.example.com/gitlab-org/gitlab-ce"
export CI_RUNNER_ID="10"
export CI_RUNNER_DESCRIPTION="my runner"
export CI_RUNNER_TAGS="docker, linux"
export CI_SERVER="yes"
export CI_SERVER_NAME="GitLab"
export CI_SERVER_REVISION="70606bf"
export CI_SERVER_VERSION="8.9.0"
export GITLAB_USER_ID="42"
export GITLAB_USER_EMAIL="user@example.com"
export CI_REGISTRY_USER="gitlab-ci-token"
export CI_REGISTRY_PASSWORD="longalfanumstring"
```
2017-05-26 07:35:30 +00:00
[ce-13784]: https://gitlab.com/gitlab-org/gitlab-ce/issues/13784
2017-07-06 07:45:38 +00:00
[eep]: https://about.gitlab.com/gitlab-ee/ "Available only in GitLab Enterprise Edition Premium"
[envs]: ../environments.md
2017-05-31 14:45:51 +00:00
[protected branches]: ../../user/project/protected_branches.md
[protected tags]: ../../user/project/protected_tags.md
2017-07-06 07:45:38 +00:00
[runner]: https://docs.gitlab.com/runner/
2017-04-14 23:01:52 +00:00
[shellexecutors]: https://docs.gitlab.com/runner/executors/
2017-07-06 07:45:38 +00:00
[triggered]: ../triggers/README.md
[triggers]: ../triggers/README.md#pass-job-variables-to-a-trigger
2017-07-03 14:43:06 +00:00
[subgroups]: ../../user/group/subgroups/index.md