README.md 19,7 КБ
Newer Older
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
1
# Variables
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
2

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
3
When receiving a job from GitLab CI, the [Runner] prepares the build environment.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
4
It starts by setting a list of **predefined variables** (environment variables)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
5
and a list of **user-defined variables**.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
6

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
7
## Priority of variables
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
8

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
9
10
11
12
The variables can be overwritten and they take precedence over each other in
this order:

1. [Trigger variables][triggers] (take precedence over all)
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
13
1. [Secret variables](#secret-variables) or [protected secret variables](#protected-secret-variables)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
14
15
1. YAML-defined [job-level variables](../yaml/README.md#job-variables)
1. YAML-defined [global variables](../yaml/README.md#variables)
Adam Niedzielski's avatar
Adam Niedzielski включено в состав коммита
16
1. [Deployment variables](#deployment-variables)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
17
18
1. [Predefined variables](#predefined-variables-environment-variables) (are the
   lowest in the chain)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
19

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
20
For example, if you define `API_TOKEN=secure` as a secret variable and
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
21
`API_TOKEN=yaml` in your `.gitlab-ci.yml`, the `API_TOKEN` will take the value
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
22
`secure` as the secret variables are higher in the chain.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
23

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
24
## Predefined variables (Environment variables)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
25

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
26
27
28
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.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
29

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
30
31
32
33
34
35
36
37
38
39
>**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 |
Stefan Hanreich's avatar
Stefan Hanreich включено в состав коммита
40
| **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. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
41
42
| **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. |
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
43
| **CI_CONFIG_PATH**              | 9.4    | 0.5    | The path to CI config file. Defaults to `.gitlab-ci.yml` |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
44
45
46
| **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. |
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
47
| **CI_ENVIRONMENT_URL**          | 9.3    | all    | The URL of the environment for this job |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
48
49
50
51
52
53
54
55
56
57
58
59
60
| **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] |
| **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 |
vanadium23's avatar
vanadium23 включено в состав коммита
61
| **CI_PROJECT_NAME**             | 8.10   | 0.5    | The project name that is currently being built (actually it is project folder name) |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
62
63
| **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 |
vanadium23's avatar
vanadium23 включено в состав коммита
64
| **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. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
| **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 |
| **RESTORE_CACHE_ATTEMPTS**      | 8.15   | 1.9    | Number of attempts to restore the cache running a job |
Douwe Maan's avatar
Douwe Maan включено в состав коммита
80

Z.J. van de Weg's avatar
Z.J. van de Weg включено в состав коммита
81
82
83
84
85
86
## 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.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
87
88
89
90
91
92
93
94
95
| 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`          |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
96
| `CI_BUILD_REPO`       | `CI_REPOSITORY_URL`     |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
97
98
99
| `CI_BUILD_TRIGGERED`  | `CI_PIPELINE_TRIGGERED` |
| `CI_BUILD_MANUAL`     | `CI_JOB_MANUAL`         |
| `CI_BUILD_TOKEN`      | `CI_JOB_TOKEN`          |
Z.J. van de Weg's avatar
Z.J. van de Weg включено в состав коммита
100

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
101
## `.gitlab-ci.yaml` defined variables
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
102
103
104

>**Note:**
This feature requires GitLab Runner 0.5.0 or higher and GitLab CI 7.14 or higher.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
105

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
106
107
108
109
110
111
112
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:
Douwe Maan's avatar
Douwe Maan включено в состав коммита
113
114
115
116
117
118

```yaml
variables:
  DATABASE_URL: "postgres://postgres@postgres/my_database"
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
119
120
121
122
123
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
Tor Bechmann Yamamoto-Sørensen's avatar
Tor Bechmann Yamamoto-Sørensen включено в состав коммита
124
global defined variables in your job, define an empty hash:
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
125
126
127

```yaml
job_name:
Sébastien's avatar
Sébastien включено в состав коммита
128
  variables: {}
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
129
130
```

TeNNoX's avatar
TeNNoX включено в состав коммита
131
132
133
134
135
136
137
138
139
140
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'
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
141
## Secret variables
Douwe Maan's avatar
Douwe Maan включено в состав коммита
142

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
143
144
>**Notes:**
- This feature requires GitLab Runner 0.4.0 or higher.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
145
- Be aware that secret variables are not masked, and their values can be shown
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
146
  in the job logs if explicitly asked to do so. If your project is public or
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
147
148
  internal, you can set the pipelines private from your project's Pipelines
  settings. Follow the discussion in issue [#13784][ce-13784] for masking the
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
149
  secret variables.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
150

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
151
152
GitLab CI allows you to define per-project **secret variables** that are set in
the build environment. The secret variables are stored out of the repository
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
153
154
155
(`.gitlab-ci.yml`) and are securely passed to GitLab Runner making them
available in the build environment. It's the recommended method to use for
storing things like passwords, secret keys and credentials.
Grzegorz Bizon's avatar
Grzegorz Bizon включено в состав коммита
156

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
157
Secret variables can be added by going to your project's
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets включено в состав коммита
158
**Settings ➔ Pipelines**, then finding the section called
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
159
**Secret variables**.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
160

Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
161
162
Once you set them, they will be available for all subsequent pipelines.

Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
163
## Protected secret variables
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
164
165

>**Notes:**
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
166
This feature requires GitLab 9.3 or higher.
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
167

Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
168
Secret variables could be protected. Whenever a secret variable is
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
169
protected, it would only be securely passed to pipelines running on the
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
170
[protected branches] or [protected tags]. The other pipelines would not get any
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
171
172
173
174
protected variables.

Protected variables can be added by going to your project's
**Settings ➔ Pipelines**, then finding the section called
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
175
**Secret variables**, and check *Protected*.
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
176
177

Once you set them, they will be available for all subsequent pipelines.
Nick Thomas's avatar
Nick Thomas включено в состав коммита
178

Adam Niedzielski's avatar
Adam Niedzielski включено в состав коммита
179
180
181
182
183
## Deployment variables

>**Note:**
This feature requires GitLab CI 8.15 or higher.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
184
[Project services](../../user/project/integrations/project_services.md) that are
Adam Niedzielski's avatar
Adam Niedzielski включено в состав коммита
185
186
responsible for deployment configuration may define their own variables that
are set in the build environment. These variables are only defined for
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
187
[deployment jobs](../environments.md). Please consult the documentation of
Adam Niedzielski's avatar
Adam Niedzielski включено в состав коммита
188
189
190
the project services that you are using to learn which variables they define.

An example project service that defines deployment variables is
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
191
[Kubernetes Service](../../user/project/integrations/kubernetes.md).
Adam Niedzielski's avatar
Adam Niedzielski включено в состав коммита
192

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
193
194
195
196
## Debug tracing

> Introduced in GitLab Runner 1.7.
>
Nick Thomas's avatar
Nick Thomas включено в состав коммита
197
> **WARNING:** Enabling debug tracing can have severe security implications. The
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
198
  output **will** contain the content of all your secret variables and any other
Nick Thomas's avatar
Nick Thomas включено в состав коммита
199
  secrets! The output **will** be uploaded to the GitLab server and made visible
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
200
  in job traces!
Nick Thomas's avatar
Nick Thomas включено в состав коммита
201
202

By default, GitLab Runner hides most of the details of what it is doing when
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
203
processing a job. This behaviour keeps job traces short, and prevents secrets
Nick Thomas's avatar
Nick Thomas включено в состав коммита
204
205
206
207
208
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
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
209
trace, resulting in a verbose job trace listing all commands that were run,
Nick Thomas's avatar
Nick Thomas включено в состав коммита
210
211
variables that were set, etc.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
212
Before enabling this, you should ensure jobs are visible to
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
213
[team members only](../../user/permissions.md#project-features). You should
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
214
also [erase](../pipelines.md#seeing-build-status) all generated job traces
Nick Thomas's avatar
Nick Thomas включено в состав коммита
215
216
217
218
219
before making them visible again.

To enable debug traces, set the `CI_DEBUG_TRACE` variable to `true`:

```yaml
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
220
job_name:
Nick Thomas's avatar
Nick Thomas включено в состав коммита
221
222
223
224
  variables:
    CI_DEBUG_TRACE: "true"
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg включено в состав коммита
258
259
++ export CI_COMMIT_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
++ CI_COMMIT_SHA=dd648b2e48ce6518303b0bb580b2ee32fadaf045
Z.J. van de Weg's avatar
Z.J. van de Weg включено в состав коммита
260
261
262
263
264
265
266
267
268
269
++ 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
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
++ 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
Z.J. van de Weg's avatar
Z.J. van de Weg включено в состав коммита
288
289
290
291
292
293
294
295
296
297
298
299
300
301
++ 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
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
++ 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
Pawel Chojnacki's avatar
Pawel Chojnacki включено в состав коммита
324
325
++ export 'CI_RUNNER_TAGS=shared, docker, linux, ruby, mysql, postgres, mongo'
++ CI_RUNNER_TAGS='shared, docker, linux, ruby, mysql, postgres, mongo'
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
326
327
328
329
330
331
332
++ 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
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
333
++ GITLAB_USER_EMAIL=user@example.com
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
334
335
336
337
338
339
340
341
++ export VERY_SECURE_VARIABLE=imaverysecurevariable
++ VERY_SECURE_VARIABLE=imaverysecurevariable
++ mkdir -p /builds/gitlab-examples/ci-debug-trace.tmp
++ echo -n '-----BEGIN CERTIFICATE-----
MIIFQzCCBCugAwIBAgIRAL/ElDjuf15xwja1ZnCocWAwDQYJKoZIhvcNAQELBQAw'

...
```
Nick Thomas's avatar
Nick Thomas включено в состав коммита
342

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
343
## Using the CI variables in your job scripts
Douwe Maan's avatar
Douwe Maan включено в состав коммита
344

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
345
346
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.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
347
In most cases `bash` or `sh` is used to execute the job script.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
348

John Spaetzel's avatar
John Spaetzel включено в состав коммита
349
To access environment variables, use the syntax for your Runner's [shell][shellexecutors].
Kamil Trzcinski's avatar
Kamil Trzcinski включено в состав коммита
350

John Spaetzel's avatar
John Spaetzel включено в состав коммита
351
352
353
354
355
356
357
358
359
| Shell                | Usage           |
|----------------------|-----------------|
| bash/sh              | `$variable`     |
| windows batch        | `%variable%`    |
| PowerShell           | `$env:variable` |

To access environment variables in bash, prefix the variable name with (`$`):

```yaml
Douwe Maan's avatar
Douwe Maan включено в состав коммита
360
361
job_name:
  script:
Elan Ruusamäe's avatar
Elan Ruusamäe включено в состав коммита
362
    - echo $CI_JOB_ID
Douwe Maan's avatar
Douwe Maan включено в состав коммита
363
364
```

John Spaetzel's avatar
John Spaetzel включено в состав коммита
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
383
You can also list all environment variables with the `export` command,
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
384
but be aware that this will also expose the values of all the secret variables
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
385
you set, in the job log:
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
386

John Spaetzel's avatar
John Spaetzel включено в состав коммита
387
```yaml
Douwe Maan's avatar
Douwe Maan включено в состав коммита
388
389
390
391
job_name:
  script:
    - export
```
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
392

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
393
394
395
396
397
398
Example values:

```bash
export CI_JOB_ID="50"
export CI_COMMIT_SHA="1ecfd275763eff1d6b4844ea3168962458c9f27a"
export CI_COMMIT_REF_NAME="master"
Mustafa YILDIRIM's avatar
Mustafa YILDIRIM включено в состав коммита
399
export CI_REPOSITORY_URL="https://gitlab-ci-token:abcde-1234ABCD5678ef@example.com/gitlab-org/gitlab-ce.git"
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
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"
```

Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
428
[ce-13784]: https://gitlab.com/gitlab-org/gitlab-ce/issues/13784
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
429
[runner]: https://docs.gitlab.com/runner/
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
430
[triggered]: ../triggers/README.md
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
431
[triggers]: ../triggers/README.md#pass-job-variables-to-a-trigger
Lin Jen-Shin's avatar
Lin Jen-Shin включено в состав коммита
432
433
[protected branches]: ../../user/project/protected_branches.md
[protected tags]: ../../user/project/protected_tags.md
John Spaetzel's avatar
John Spaetzel включено в состав коммита
434
[shellexecutors]: https://docs.gitlab.com/runner/executors/
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
435
[eep]: https://about.gitlab.com/gitlab-ee/ "Available only in GitLab Enterprise Edition Premium"