README.md 97.6 KB
Newer Older
M
Marcia Ramos 已提交
1 2 3 4
---
type: reference
---

E
Evan Read 已提交
5
# GitLab CI/CD Pipeline Configuration Reference
D
Douwe Maan 已提交
6

E
Evan Read 已提交
7
GitLab CI/CD [pipelines](../pipelines.md) are configured using a YAML file called `.gitlab-ci.yml` within each project.
8

E
Evan Read 已提交
9
The `.gitlab-ci.yml` file defines the structure and order of the pipelines and determines:
10

E
Evan Read 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23
- What to execute using [GitLab Runner](https://docs.gitlab.com/runner/).
- What decisions to make when specific conditions are encountered. For example, when a process succeeds or fails.

This topic covers CI/CD pipeline configuration. For other CI/CD configuration information, see:

- [GitLab CI/CD Variables](../variables/README.md), for configuring the environment the pipelines run in.
- [GitLab Runner advanced configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html), for configuring GitLab Runner.

We have complete examples of configuring pipelines:

- For a quick introduction to GitLab CI, follow our [quick start guide](../quick_start/README.md).
- For a collection of examples, see [GitLab CI/CD Examples](../examples/README.md).
- To see a large `.gitlab-ci.yml` file used in an enterprise, see the [`.gitlab-ci.yml` file for `gitlab-ce`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab-ci.yml).
24

25
NOTE: **Note:**
M
Marcel Amirault 已提交
26
If you have a [mirrored repository where GitLab pulls from](../../workflow/repository_mirroring.md#pulling-from-a-remote-repository-starter),
27 28 29
you may need to enable pipeline triggering in your project's
**Settings > Repository > Pull from a remote repository > Trigger pipelines for mirror updates**.

E
Evan Read 已提交
30 31 32
## Introduction

Pipeline configuration begins with jobs. Jobs are the most fundamental element of a `.gitlab-ci.yml` file.
33

E
Evan Read 已提交
34 35 36 37 38 39 40
Jobs are:

- Defined with constraints stating under what conditions they should be executed.
- Top-level elements with an arbitrary name and must contain at least the [`script`](#script) clause.
- Not limited in how many can be defined.

For example:
D
Douwe Maan 已提交
41 42 43 44 45 46 47 48 49

```yaml
job1:
  script: "execute-script-for-job1"

job2:
  script: "execute-script-for-job2"
```

50
The above example is the simplest possible CI/CD configuration with two separate
51 52 53
jobs, where each of the jobs executes a different command.
Of course a command can execute code directly (`./configure;make;make install`)
or run a script (`test.sh`) in the repository.
D
Douwe Maan 已提交
54

55 56 57
Jobs are picked up by [Runners](../runners/README.md) and executed within the
environment of the Runner. What is important, is that each job is run
independently from each other.
D
Douwe Maan 已提交
58

E
Evan Read 已提交
59 60 61 62
### Validate the .gitlab-ci.yml

Each instance of GitLab CI has an embedded debug tool called Lint, which validates the
content of your `.gitlab-ci.yml` files. You can find the Lint under the page `ci/lint` of your
M
Marcel Amirault 已提交
63
project namespace. For example, `https://gitlab.example.com/gitlab-org/project-123/-/ci/lint`.
E
Evan Read 已提交
64 65 66

### Unavailable names for jobs

67 68
Each job must have a unique name, but there are a few **reserved `keywords` that
cannot be used as job names**:
D
Douwe Maan 已提交
69

70 71 72 73 74 75 76 77
- `image`
- `services`
- `stages`
- `types`
- `before_script`
- `after_script`
- `variables`
- `cache`
D
Douwe Maan 已提交
78

E
Evan Read 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
### Using reserved keywords

If you get validation error when using specific values (for example, `true` or `false`), try to:

- Quote them.
- Change them to a different form. For example, `/bin/true`.

## Configuration parameters

A job is defined as a list of parameters that define the job's behavior.

The following table lists available parameters for jobs:

| Keyword                                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`script`](#script)                                | Shell script which is executed by Runner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [`image`](#image)                                  | Use docker images. Also available: `image:name` and `image:entrypoint`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [`services`](#services)                            | Use docker services images. Also available: `services:name`, `services:alias`, `services:entrypoint`, and `services:command`.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| [`before_script`](#before_script-and-after_script) | Override a set of commands that are executed before job.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| [`after_script`](#before_script-and-after_script)  | Override a set of commands that are executed after job.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [`stages`](#stages)                                | Define stages in a pipeline.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| [`stage`](#stage)                                  | Defines a job stage (default: `test`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [`only`](#onlyexcept-basic)                        | Limit when jobs are created. Also available: [`only:refs`, `only:kubernetes`, `only:variables`, and `only:changes`](#onlyexcept-advanced).                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [`except`](#onlyexcept-basic)                      | Limit when jobs are not created. Also available: [`except:refs`, `except:kubernetes`, `except:variables`, and `except:changes`](#onlyexcept-advanced).                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [`tags`](#tags)                                    | List of tags which are used to select Runner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| [`allow_failure`](#allow_failure)                  | Allow job to fail. Failed job doesn't contribute to commit status.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [`when`](#when)                                    | When to run job. Also available: `when:manual` and `when:delayed`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [`environment`](#environment)                      | Name of an environment to which the job deploys. Also available: `environment:name`, `environment:url`, `environment:on_stop`, and `environment:action`.                                                                                                                                                                                                                                                                                                                                                                                                                                |
| [`cache`](#cache)                                  | List of files that should be cached between subsequent runs. Also available: `cache:paths`, `cache:key`, `cache:untracked`, and `cache:policy`.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
M
Marcel Amirault 已提交
108
| [`artifacts`](#artifacts)                          | List of files and directories to attach to a job on success. Also available: `artifacts:paths`, `artifacts:name`, `artifacts:untracked`, `artifacts:when`, `artifacts:expire_in`, `artifacts:reports`, and `artifacts:reports:junit`.<br><br>In GitLab [Enterprise Edition](https://about.gitlab.com/pricing/), these are available: `artifacts:reports:codequality`, `artifacts:reports:sast`, `artifacts:reports:dependency_scanning`, `artifacts:reports:container_scanning`, `artifacts:reports:dast`, `artifacts:reports:license_management`, `artifacts:reports:performance` and `artifacts:reports:metrics`. |
E
Evan Read 已提交
109 110 111 112 113 114
| [`dependencies`](#dependencies)                    | Other jobs that a job depends on so that you can pass artifacts between them.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| [`coverage`](#coverage)                            | Code coverage settings for a given job.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [`retry`](#retry)                                  | When and how many times a job can be auto-retried in case of a failure.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [`parallel`](#parallel)                            | How many instances of a job should be run in parallel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [`trigger`](#trigger-premium)                      | Defines a downstream pipeline trigger.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [`include`](#include)                              | Allows this job to include external YAML files. Also available: `include:local`, `include:file`, `include:template`, and `include:remote`.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
W
Wolphin 已提交
115
| [`extends`](#extends)                              | Configuration entries that this job is going to inherit from.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
E
Evan Read 已提交
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
| [`pages`](#pages)                                  | Upload the result of a job to use with GitLab Pages.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [`variables`](#variables)                          | Define job variables on a job level.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

NOTE: **Note:**
Parameters `types` and `type` are [deprecated](#deprecated-parameters).

## Parameter details

The following are detailed explanations for parameters used to configure CI/CD pipelines.

### `script`

`script` is the only required keyword that a job needs. It's a shell script
which is executed by the Runner. For example:

```yaml
job:
  script: "bundle exec rspec"
```

This parameter can also contain several commands using an array:

```yaml
job:
  script:
    - uname -a
    - bundle exec rspec
```

NOTE: **Note:**
Sometimes, `script` commands will need to be wrapped in single or double quotes.
For example, commands that contain a colon (`:`) need to be wrapped in quotes so
that the YAML parser knows to interpret the whole thing as a string rather than
a "key: value" pair. Be careful when using special characters:
`:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``.

### `image`

Used to specify [a Docker image](../docker/using_docker_images.md#what-is-an-image) to use for the job.

For:

- Simple definition examples, see [Define `image` and `services` from .gitlab-ci.yml](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml).
- Detailed usage information, refer to [Docker integration](../docker/README.md) documentation.

#### `image:name`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see [Available settings for `image`](../docker/using_docker_images.md#available-settings-for-image).

#### `image:entrypoint`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see [Available settings for `image`](../docker/using_docker_images.md#available-settings-for-image).

### `services`

Used to specify a [service Docker image](../docker/using_docker_images.md#what-is-a-service), linked to a base image specified in [`image`](#image).

For:

- Simple definition examples, see [Define `image` and `services` from .gitlab-ci.yml](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml).
- Detailed usage information, refer to [Docker integration](../docker/README.md) documentation.
- For example services, see [GitLab CI Services](../services/README.md).

#### `services:name`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see see [Available settings for `services`](../docker/using_docker_images.md#available-settings-for-services).

#### `services:alias`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see see [Available settings for `services`](../docker/using_docker_images.md#available-settings-for-services).

#### `services:entrypoint`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see see [Available settings for `services`](../docker/using_docker_images.md#available-settings-for-services).

#### `services:command`

An [extended docker configuration option](../docker/using_docker_images.md#extended-docker-configuration-options).

For more information, see see [Available settings for `services`](../docker/using_docker_images.md#available-settings-for-services).

### `before_script` and `after_script`

> Introduced in GitLab 8.7 and requires GitLab Runner v1.2.
K
Kamil Trzcinski 已提交
210

211 212 213 214
`before_script` is used to define the command that should be run before all
jobs, including deploy jobs, but after the restoration of [artifacts](#artifacts).
This can be an array or a multi-line string.

215
`after_script` is used to define the command that will be run after all
216
jobs, including failed ones. This has to be an array or a multi-line string.
217

E
Evan Read 已提交
218
Scripts specified in `before_script` are:
219

E
Evan Read 已提交
220 221 222 223 224
- Concatenated with scripts specified in the main `script`. Job-level
  `before_script` definition override global-level `before_script` definition
  when concatenated with `script` definition.
- Executed together with main `script` script as one script in a single shell
  context.
225

E
Evan Read 已提交
226
Scripts specified in `after_script`:
227 228

- Have a current working directory set back to the default.
E
Evan Read 已提交
229 230 231 232 233 234 235 236
- Are executed in a shell context separated from `before_script` and `script`
  scripts.
- Because of separated context, cannot see changes done by scripts defined
  in `before_script` or `script` scripts, either:
  - In shell. For example, command aliases and variables exported in `script`
    scripts.
  - Outside of the working tree (depending on the Runner executor). For example,
    software installed by a `before_script` or `script` scripts.
237

238 239
It's possible to overwrite the globally defined `before_script` and `after_script`
if you set it per-job:
240

241 242
```yaml
before_script:
P
pityonline 已提交
243
  - global before script
244 245 246

job:
  before_script:
P
pityonline 已提交
247
    - execute this instead of global before script
248
  script:
P
pityonline 已提交
249
    - my command
250
  after_script:
P
pityonline 已提交
251
    - execute this after my script
252 253
```

E
Evan Read 已提交
254
### `stages`
D
Douwe Maan 已提交
255

256 257 258 259
`stages` is used to define stages that can be used by jobs and is defined
globally.

The specification of `stages` allows for having flexible multi stage pipelines.
260
The ordering of elements in `stages` defines the ordering of jobs' execution:
D
Douwe Maan 已提交
261

262 263
1. Jobs of the same stage are run in parallel.
1. Jobs of the next stage are run after the jobs from the previous stage
264
   complete successfully.
D
Douwe Maan 已提交
265 266

Let's consider the following example, which defines 3 stages:
267 268

```yaml
D
Douwe Maan 已提交
269 270 271 272 273 274
stages:
  - build
  - test
  - deploy
```

275
1. First, all jobs of `build` are executed in parallel.
276 277
1. If all jobs of `build` succeed, the `test` jobs are executed in parallel.
1. If all jobs of `test` succeed, the `deploy` jobs are executed in parallel.
278
1. If all jobs of `deploy` succeed, the commit is marked as `passed`.
279 280
1. If any of the previous jobs fails, the commit is marked as `failed` and no
   jobs of further stage are executed.
281

282
There are also two edge cases worth mentioning:
283

284 285
1. If no `stages` are defined in `.gitlab-ci.yml`, then the `build`,
   `test` and `deploy` are allowed to be used as job's stage by default.
E
Evan Read 已提交
286
1. If a job doesn't specify a `stage`, the job is assigned the `test` stage.
287

E
Evan Read 已提交
288
### `stage`
289

290 291
`stage` is defined per-job and relies on [`stages`](#stages) which is defined
globally. It allows to group jobs into different stages, and jobs of the same
292
`stage` are executed in parallel (subject to [certain conditions](#using-your-own-runners)). For example:
D
Douwe Maan 已提交
293 294

```yaml
295 296 297 298 299 300 301 302 303 304 305 306 307 308
stages:
  - build
  - test
  - deploy

job 1:
  stage: build
  script: make build dependencies

job 2:
  stage: build
  script: make build artifacts

job 3:
D
Douwe Maan 已提交
309
  stage: test
310 311 312 313 314
  script: make test

job 4:
  stage: deploy
  script: make deploy
D
Douwe Maan 已提交
315 316
```

317 318 319 320 321 322 323 324 325 326 327
#### Using your own Runners

When using your own Runners, GitLab Runner runs only one job at a time by default (see the
`concurrent` flag in [Runner global settings](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section)
for more information).

Jobs will run on your own Runners in parallel only if:

- Run on different Runners.
- The Runner's `concurrent` setting has been changed.

E
Evan Read 已提交
328
### `only`/`except` (basic)
D
Douwe Maan 已提交
329

330 331
`only` and `except` are two parameters that set a job policy to limit when
jobs are created:
D
Douwe Maan 已提交
332

333
1. `only` defines the names of branches and tags for which the job will run.
E
Evan Read 已提交
334
1. `except` defines the names of branches and tags for which the job will
335
    **not** run.
336

337
There are a few rules that apply to the usage of job policy:
338

339
- `only` and `except` are inclusive. If both `only` and `except` are defined
340
   in a job specification, the ref is filtered by `only` and `except`.
C
Cody Mize 已提交
341
- `only` and `except` allow the use of regular expressions ([supported regexp syntax](#supported-onlyexcept-regexp-syntax)).
342
- `only` and `except` allow to specify a repository path to filter jobs for
343 344
   forks.

345 346 347 348
In addition, `only` and `except` allow the use of special keywords:

| **Value** |  **Description**  |
| --------- |  ---------------- |
349 350 351 352 353 354 355 356 357 358
| `branches`       | When a git reference of a pipeline is a branch.  |
| `tags`           | When a git reference of a pipeline is a tag.  |
| `api`            | When pipeline has been triggered by a second pipelines API (not triggers API).  |
| `external`       | When using CI services other than GitLab. |
| `pipelines`      | For multi-project triggers, created using the API with `CI_JOB_TOKEN`. |
| `pushes`         | Pipeline is triggered by a `git push` by the user. |
| `schedules`      | For [scheduled pipelines][schedules]. |
| `triggers`       | For pipelines created using a trigger token. |
| `web`            | For pipelines created using **Run pipeline** button in GitLab UI (under your project's **Pipelines**). |
| `merge_requests` | When a merge request is created or updated (See [pipelines for merge requests](../merge_request_pipelines/index.md)). |
359
| `chats`          | For jobs created using a [GitLab ChatOps](../chatops/README.md) command. |
360

361
In the example below, `job` will run only for refs that start with `issue-`,
362
whereas all branches will be skipped:
D
Douwe Maan 已提交
363 364 365

```yaml
job:
366
  # use regexp
D
Douwe Maan 已提交
367
  only:
368 369
    - /^issue-.*$/
  # use special keyword
D
Douwe Maan 已提交
370
  except:
371
    - branches
D
Douwe Maan 已提交
372 373
```

374 375 376 377 378 379 380 381 382 383 384 385 386
Pattern matching is case-sensitive by default. Use `i` flag modifier, like
`/pattern/i` to make a pattern case-insensitive:

```yaml
job:
  # use regexp
  only:
    - /^issue-.*$/i
  # use special keyword
  except:
    - branches
```

387
In this example, `job` will run only for refs that are tagged, or if a build is
388
explicitly requested via an API trigger or a [Pipeline Schedule][schedules]:
389 390 391 392 393 394 395

```yaml
job:
  # use special keywords
  only:
    - tags
    - triggers
396
    - schedules
397 398
```

399 400
The repository path can be used to have jobs executed only for the parent
repository and not forks:
401 402 403 404 405 406 407

```yaml
job:
  only:
    - branches@gitlab-org/gitlab-ce
  except:
    - master@gitlab-org/gitlab-ce
408
    - /^release/.*$/@gitlab-org/gitlab-ce
409
```
410 411

The above example will run `job` for all branches on `gitlab-org/gitlab-ce`,
412
except `master` and those with names prefixed with `release/`.
413

414 415
If a job does not have an `only` rule, `only: ['branches', 'tags']` is set by
default. If it doesn't have an `except` rule, it is empty.
416 417 418 419 420 421 422 423

For example,

```yaml
job:
  script: echo 'test'
```

424
is translated to:
425 426 427 428 429 430 431

```yaml
job:
  script: echo 'test'
  only: ['branches', 'tags']
```

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
#### Regular expressions

Because `@` is used to denote the beginning of a ref's repository path,
matching a ref name containing the `@` character in a regular expression
requires the use of the hex character code match `\x40`.

Only the tag or branch name can be matched by a regular expression.
The repository path, if given, is always matched literally.

If a regular expression shall be used to match the tag or branch name,
the entire ref name part of the pattern has to be a regular expression,
and must be surrounded by `/`.
(With regular expression flags appended after the closing `/`.)
So `issue-/.*/` won't work to match all tag names or branch names
that begin with `issue-`.

TIP: **Tip**
Use anchors `^` and `$` to avoid the regular expression
matching only a substring of the tag name or branch name.
For example, `/^issue-.*$/` is equivalent to `/^issue-/`,
while just `/issue/` would also match a branch called `severe-issues`.

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
### Supported `only`/`except` regexp syntax

CAUTION: **Warning:**
This is a breaking change that was introduced with GitLab 11.9.4.

In GitLab 11.9.4, GitLab begun internally converting regexp used
in `only` and `except` parameters to [RE2](https://github.com/google/re2/wiki/Syntax).

This means that only subset of features provided by [Ruby Regexp](https://ruby-doc.org/core/Regexp.html)
is supported. [RE2](https://github.com/google/re2/wiki/Syntax) limits the set of features
provided due to computational complexity, which means some features became unavailable in GitLab 11.9.4.
For example, negative lookaheads.

For GitLab versions from 11.9.7 and up to GitLab 12.0, GitLab provides a feature flag that can be
enabled by administrators that allows users to use unsafe regexp syntax. This brings compatibility
with previously allowed syntax version and allows users to gracefully migrate to the new syntax.

```ruby
Feature.enable(:allow_unsafe_ruby_regexp)
```

E
Evan Read 已提交
475
### `only`/`except` (advanced)
476

477
CAUTION: **Warning:**
T
Takuya Noguchi 已提交
478
This an _alpha_ feature, and it is subject to change at any time without
479
prior notice!
480

481 482
GitLab supports both simple and complex strategies, so it's possible to use an
array and a hash configuration scheme.
483

484
Four keys are available:
485

486 487 488 489
- `refs`
- `variables`
- `changes`
- `kubernetes`
490

491
If you use multiple keys under `only` or `except`, they act as an AND. The logic is:
492

493
> (any of refs) AND (any of variables) AND (any of changes) AND (if kubernetes is active)
494

E
Evan Read 已提交
495
#### `only:refs`/`except:refs`
496

497 498
> `refs` policy introduced in GitLab 10.0.

499
The `refs` strategy can take the same values as the
500
[simplified only/except configuration](#onlyexcept-basic).
501

502 503
In the example below, the `deploy` job is going to be created only when the
pipeline has been [scheduled][schedules] or runs for the `master` branch:
504 505

```yaml
506
deploy:
507 508 509 510
  only:
    refs:
      - master
      - schedules
511 512
```

E
Evan Read 已提交
513
#### `only:kubernetes`/`except:kubernetes`
514

515 516
> `kubernetes` policy introduced in GitLab 10.0.

517 518 519 520 521 522 523 524
The `kubernetes` strategy accepts only the `active` keyword.

In the example below, the `deploy` job is going to be created only when the
Kubernetes service is active in the project:

```yaml
deploy:
  only:
525 526 527
    kubernetes: active
```

E
Evan Read 已提交
528
#### `only:variables`/`except:variables`
529

530 531
> `variables` policy introduced in GitLab 10.7.

532 533 534 535 536
The `variables` keyword is used to define variables expressions. In other words,
you can use predefined variables / project / group or
environment-scoped variables to define an expression GitLab is going to
evaluate in order to decide whether a job should be created or not.

537
Examples of using variables expressions:
538 539 540

```yaml
deploy:
541
  script: cap staging deploy
542 543 544 545 546 547 548 549
  only:
    refs:
      - branches
    variables:
      - $RELEASE == "staging"
      - $STAGING
```

550
Another use case is excluding jobs depending on a commit message:
551 552 553 554 555 556 557 558 559

```yaml
end-to-end:
  script: rake test:end-to-end
  except:
    variables:
      - $CI_COMMIT_MESSAGE =~ /skip-end-to-end-tests/
```

560
Learn more about [variables expressions](../variables/README.md#environment-variables-expressions).
561

E
Evan Read 已提交
562
#### `only:changes`/`except:changes`
563

564 565
> `changes` policy [introduced][ce-19232] in GitLab 11.4.

566
Using the `changes` keyword with `only` or `except` makes it possible to define if
567 568 569
a job should be created based on files modified by a git push event.

For example:
570 571 572 573 574 575 576 577

```yaml
docker build:
  script: docker build -t my-image:$CI_COMMIT_REF_SLUG .
  only:
    changes:
      - Dockerfile
      - docker/scripts/*
L
Lukas Schneider 已提交
578
      - dockerfiles/**/*
K
Kirill Zaitsev 已提交
579
      - more_scripts/*.{rb,py,sh}
580 581
```

582
In the scenario above, when pushing multiple commits to GitLab to an existing
583 584
branch, GitLab creates and triggers the `docker build` job, provided that one of the
commits contains changes to any of the following:
585 586 587

- The `Dockerfile` file.
- Any of the files inside `docker/scripts/` directory.
588 589
- Any of the files and subdirectories inside the `dockerfiles` directory.
- Any of the files with `rb`, `py`, `sh` extensions inside the `more_scripts` directory.
590

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
You can also use glob patterns to match multiple files in either the root directory of the repo, or in _any_ directory within the repo. For example:

```yaml
test:
  script: npm run test
  only:
    changes:
      - "*.json"
      - "**/*.sql"
```

NOTE: **Note:**
In the example above, the expressions are wrapped double quotes because they are glob patterns. GitLab will fail to parse `.gitlab-ci.yml` files with unwrapped glob patterns.

The following example will skip the CI job if a change is detected in any file in the root directory of the repo with a `.md` extension:

```yaml
build:
  script: npm run build
  except:
    changes:
      - "*.md"
```

615
CAUTION: **Warning:**
616 617 618
There are some caveats when using this feature with new branches and tags. See
the section below.

E
Evan Read 已提交
619
##### Using `changes` with new branches and tags
620

621 622 623 624
When pushing a **new** branch or a **new** tag to GitLab, the policy always
evaluates to true and GitLab will create a job. This feature is not connected
with merge requests yet and, because GitLab is creating pipelines before a user
can create a merge request, it is unknown what the target branch is at this point.
625

E
Evan Read 已提交
626
##### Using `changes` with `merge_requests`
627 628

With [pipelines for merge requests](../merge_request_pipelines/index.md),
629
it is possible to define a job to be created based on files modified
630 631 632 633
in a merge request.

For example:

634
```yaml
635 636 637 638 639 640 641 642 643 644
docker build service one:
  script: docker build -t my-service-one-image:$CI_COMMIT_REF_SLUG .
  only:
    refs:
      - merge_requests
    changes:
      - Dockerfile
      - service-one/**/*
```

645 646 647
In the scenario above, if a merge request is created or updated that changes
either files in `service-one` directory or the `Dockerfile`, GitLab creates
and triggers the `docker build service one` job.
648

E
Evan Read 已提交
649
### `tags`
D
Douwe Maan 已提交
650

651
`tags` is used to select specific Runners from the list of all Runners that are
652
allowed to run this project.
D
Douwe Maan 已提交
653

654
During the registration of a Runner, you can specify the Runner's tags, for
655 656
example `ruby`, `postgres`, `development`.

657
`tags` allow you to run jobs with Runners that have the specified tags
658 659 660
assigned to them:

```yaml
D
Douwe Maan 已提交
661 662 663 664 665 666
job:
  tags:
    - ruby
    - postgres
```

667
The specification above, will make sure that `job` is built by a Runner that
668
has both `ruby` AND `postgres` tags defined.
D
Douwe Maan 已提交
669

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
Tags are also a great way to run different jobs on different platforms, for
example, given an OS X Runner with tag `osx` and Windows Runner with tag
`windows`, the following jobs run on respective platforms:

```yaml
windows job:
  stage:
    - build
  tags:
    - windows
  script:
    - echo Hello, %USERNAME%!

osx job:
  stage:
    - build
  tags:
    - osx
  script:
    - echo "Hello, $USER!"
```

E
Evan Read 已提交
692
### `allow_failure`
693

694 695
`allow_failure` allows a job to fail without impacting the rest of the CI
suite.
696
The default value is `false`, except for [manual](#whenmanual) jobs.
697

698 699 700 701 702 703 704
When enabled and the job fails, the job will show an orange warning in the UI.
However, the logical flow of the pipeline will consider the job a
success/passed, and is not blocked.

Assuming all other jobs are successful, the job's stage and its pipeline will
show the same orange warning. However, the associated commit will be marked
"passed", without warnings.
705 706 707 708 709 710 711 712 713

In the example below, `job1` and `job2` will run in parallel, but if `job1`
fails, it will not stop the next stage from running, since it's marked with
`allow_failure: true`:

```yaml
job1:
  stage: test
  script:
P
pityonline 已提交
714
    - execute_script_that_will_fail
715 716 717 718 719
  allow_failure: true

job2:
  stage: test
  script:
P
pityonline 已提交
720
    - execute_script_that_will_succeed
721 722 723 724

job3:
  stage: deploy
  script:
P
pityonline 已提交
725
    - deploy_to_staging
726 727
```

E
Evan Read 已提交
728
### `when`
729 730 731

`when` is used to implement jobs that are run in case of failure or despite the
failure.
732

R
Robert Speicher 已提交
733 734
`when` can be set to one of the following values:

735
1. `on_success` - execute job only when all jobs from prior stages
736 737
    succeed (or are considered succeeding because they are marked
    `allow_failure`). This is the default.
738
1. `on_failure` - execute job only when at least one job from prior stages
739
    fails.
740 741
1. `always` - execute job regardless of the status of jobs from prior stages.
1. `manual` - execute job manually (added in GitLab 8.10). Read about
742
    [manual actions](#whenmanual) below.
743

744 745 746
For example:

```yaml
747
stages:
P
pityonline 已提交
748 749 750 751 752
  - build
  - cleanup_build
  - test
  - deploy
  - cleanup
753

754
build_job:
755 756
  stage: build
  script:
P
pityonline 已提交
757
    - make build
758

759
cleanup_build_job:
760 761
  stage: cleanup_build
  script:
P
pityonline 已提交
762
    - cleanup build when failed
763 764
  when: on_failure

765
test_job:
766 767
  stage: test
  script:
P
pityonline 已提交
768
    - make test
769

770
deploy_job:
771 772
  stage: deploy
  script:
P
pityonline 已提交
773
    - make deploy
774
  when: manual
775

776
cleanup_job:
777 778
  stage: cleanup
  script:
P
pityonline 已提交
779
    - cleanup after jobs
780 781 782 783
  when: always
```

The above script will:
784

785
1. Execute `cleanup_build_job` only when `build_job` fails.
E
Evan Read 已提交
786
1. Always execute `cleanup_job` as the last step in pipeline regardless of
787
   success or failure.
E
Evan Read 已提交
788
1. Allow you to manually execute `deploy_job` from GitLab's UI.
789

E
Evan Read 已提交
790
#### `when:manual`
791

792 793 794
> - Introduced in GitLab 8.10.
> - Blocking manual actions were introduced in GitLab 9.0.
> - Protected actions were introduced in GitLab 9.2.
795

796 797 798 799
Manual actions are a special type of job that are not executed automatically,
they need to be explicitly started by a user. An example usage of manual actions
would be a deployment to a production environment. Manual actions can be started
from the pipeline, job, environment, and deployment views. Read more at the
800
[environments documentation](../environments.md#configuring-manual-deployments).
801

802 803
Manual actions can be either optional or blocking. Blocking manual actions will
block the execution of the pipeline at the stage this action is defined in. It's
804
possible to resume execution of the pipeline when someone executes a blocking
805
manual action by clicking a _play_ button.
806

807
When a pipeline is blocked, it will not be merged if Merge When Pipeline Succeeds
808 809 810 811 812
is set. Blocked pipelines also do have a special status, called _manual_.
Manual actions are non-blocking by default. If you want to make manual action
blocking, it is necessary to add `allow_failure: false` to the job's definition
in `.gitlab-ci.yml`.

813 814 815
Optional manual actions have `allow_failure: true` set by default and their
Statuses do not contribute to the overall pipeline status. So, if a manual
action fails, the pipeline will eventually succeed.
816

817 818
Manual actions are considered to be write actions, so permissions for
[protected branches](../../user/project/protected_branches.md) are used when
B
Brendan O'Leary 🐢 已提交
819 820 821
a user wants to trigger an action. In other words, in order to trigger a manual
action assigned to a branch that the pipeline is running for, the user needs to
have the ability to merge to this branch.
822

E
Evan Read 已提交
823
#### `when:delayed`
W
Winnie Hellmann 已提交
824 825 826 827 828 829 830

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21767) in GitLab 11.4.

Delayed job are for executing scripts after a certain period.
This is useful if you want to avoid jobs entering `pending` state immediately.

You can set the period with `start_in` key. The value of `start_in` key is an elapsed time in seconds, unless a unit is
831
provided. `start_in` key must be less than or equal to one hour. Examples of valid values include:
W
Winnie Hellmann 已提交
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

- `10 seconds`
- `30 minutes`
- `1 hour`

When there is a delayed job in a stage, the pipeline will not progress until the delayed job has finished.
This means this keyword can also be used for inserting delays between different stages.

The timer of a delayed job starts immediately after the previous stage has completed.
Similar to other types of jobs, a delayed job's timer will not start unless the previous stage passed.

The following example creates a job named `timed rollout 10%` that is executed 30 minutes after the previous stage has completed:

```yaml
timed rollout 10%:
  stage: deploy
  script: echo 'Rolling out 10% ...'
  when: delayed
  start_in: 30 minutes
```

You can stop the active timer of a delayed job by clicking the **Unschedule** button.
This job will never be executed in the future unless you execute the job manually.

You can start a delayed job immediately by clicking the **Play** button.
GitLab runner will pick your job soon and start the job.

E
Evan Read 已提交
859
### `environment`
860

861 862 863
> - Introduced in GitLab 8.9.
> - You can read more about environments and find more examples in the
>   [documentation about environments][environment].
864

865
`environment` is used to define that a job deploys to a specific environment.
M
Mark Pundsack 已提交
866 867
If `environment` is specified and no environment under that name exists, a new
one will be created automatically.
868

869
In its simplest form, the `environment` keyword can be defined like:
870

871
```yaml
872 873 874
deploy to production:
  stage: deploy
  script: git push production HEAD:master
875 876
  environment:
    name: production
877 878
```

879 880 881
In the above example, the `deploy to production` job will be marked as doing a
deployment to the `production` environment.

E
Evan Read 已提交
882
#### `environment:name`
883

884 885 886 887 888 889 890
> - Introduced in GitLab 8.11.
> - Before GitLab 8.11, the name of an environment could be defined as a string like
>   `environment: production`. The recommended way now is to define it under the
>   `name` keyword.
> - The `name` parameter can use any of the defined CI variables,
>   including predefined, secure variables and `.gitlab-ci.yml` [`variables`](#variables).
>   You however cannot use variables defined under `script`.
891

892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
The `environment` name can contain:

- letters
- digits
- spaces
- `-`
- `_`
- `/`
- `$`
- `{`
- `}`

Common names are `qa`, `staging`, and `production`, but you can use whatever
name works with your workflow.

907 908 909 910
Instead of defining the name of the environment right after the `environment`
keyword, it is also possible to define it as a separate value. For that, use
the `name` keyword under `environment`:

911
```yaml
912 913 914 915 916 917 918
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment:
    name: production
```

E
Evan Read 已提交
919
#### `environment:url`
920

921 922 923 924 925 926
> - Introduced in GitLab 8.11.
> - Before GitLab 8.11, the URL could be added only in GitLab's UI. The
>   recommended way now is to define it in `.gitlab-ci.yml`.
> - The `url` parameter can use any of the defined CI variables,
>   including predefined, secure variables and `.gitlab-ci.yml` [`variables`](#variables).
>   You however cannot use variables defined under `script`.
927 928 929 930 931 932 933 934

This is an optional value that when set, it exposes buttons in various places
in GitLab which when clicked take you to the defined URL.

In the example below, if the job finishes successfully, it will create buttons
in the merge requests and in the environments/deployments pages which will point
to `https://prod.example.com`.

935
```yaml
936 937 938 939 940 941 942 943
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment:
    name: production
    url: https://prod.example.com
```

E
Evan Read 已提交
944
#### `environment:on_stop`
945

946 947 948 949
> - [Introduced][ce-6669] in GitLab 8.13.
> - Starting with GitLab 8.14, when you have an environment that has a stop action
>   defined, GitLab will automatically trigger a stop action when the associated
>   branch is deleted.
950

951
Closing (stopping) environments can be achieved with the `on_stop` keyword defined under
952 953 954 955 956
`environment`. It declares a different job that runs in order to close
the environment.

Read the `environment:action` section for an example.

E
Evan Read 已提交
957
#### `environment:action`
958 959 960 961 962 963

> [Introduced][ce-6669] in GitLab 8.13.

The `action` keyword is to be used in conjunction with `on_stop` and is defined
in the job that is called to close the environment.

964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
Take for instance:

```yaml
review_app:
  stage: deploy
  script: make deploy-app
  environment:
    name: review
    on_stop: stop_review_app

stop_review_app:
  stage: deploy
  script: make delete-app
  when: manual
  environment:
    name: review
    action: stop
```

In the above example we set up the `review_app` job to deploy to the `review`
environment, and we also defined a new `stop_review_app` job under `on_stop`.
Once the `review_app` job is successfully finished, it will trigger the
`stop_review_app` job based on what is defined under `when`. In this case we
E
Evan Read 已提交
987
set it up to `manual` so it will need a [manual action](#whenmanual) via
988 989 990 991 992 993 994 995 996 997
GitLab's web interface in order to run.

The `stop_review_app` job is **required** to have the following keywords defined:

- `when` - [reference](#when)
- `environment:name`
- `environment:action`
- `stage` should be the same as the `review_app` in order for the environment
  to stop automatically when the branch is deleted

E
Evan Read 已提交
998
#### Dynamic environments
999

1000 1001 1002 1003 1004
> - [Introduced][ce-6323] in GitLab 8.12 and GitLab Runner 1.6.
> - The `$CI_ENVIRONMENT_SLUG` was [introduced][ce-7983] in GitLab 8.15.
> - The `name` and `url` parameters can use any of the defined CI variables,
>   including predefined, secure variables and `.gitlab-ci.yml` [`variables`](#variables).
>   You however cannot use variables defined under `script`.
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

For example:

```yaml
deploy as review app:
  stage: deploy
  script: make deploy
  environment:
    name: review/$CI_COMMIT_REF_NAME
    url: https://$CI_ENVIRONMENT_SLUG.example.com/
```

The `deploy as review app` job will be marked as deployment to dynamically
create the `review/$CI_COMMIT_REF_NAME` environment, where `$CI_COMMIT_REF_NAME`
is an [environment variable][variables] set by the Runner. The
`$CI_ENVIRONMENT_SLUG` variable is based on the environment name, but suitable
for inclusion in URLs. In this case, if the `deploy as review app` job was run
in a branch named `pow`, this environment would be accessible with an URL like
`https://review-pow.example.com/`.

This of course implies that the underlying server which hosts the application
is properly configured.

The common use case is to create dynamic environments for branches and use them
as Review Apps. You can see a simple example using Review Apps at
<https://gitlab.com/gitlab-examples/review-apps-nginx/>.

E
Evan Read 已提交
1032
### `cache`
1033

1034 1035 1036 1037 1038
> - Introduced in GitLab Runner v0.7.0.
> - `cache` can be set globally and per-job.
> - From GitLab 9.0, caching is enabled and shared between pipelines and jobs
>   by default.
> - From GitLab 9.2, caches are restored before [artifacts](#artifacts).
1039

1040 1041 1042 1043
TIP: **Learn more:**
Read how caching works and find out some good practices in the
[caching dependencies documentation](../caching/index.md).

1044 1045 1046 1047 1048 1049 1050
`cache` is used to specify a list of files and directories which should be
cached between jobs. You can only use paths that are within the project
workspace.

If `cache` is defined outside the scope of jobs, it means it is set
globally and all jobs will use that definition.

E
Evan Read 已提交
1051
#### `cache:paths`
1052

1053 1054
Use the `paths` directive to choose which files or directories will be cached.
Wildcards can be used as well.
1055

1056
Cache all files in `binaries` that end in `.apk` and the `.config` file:
1057 1058 1059 1060 1061 1062

```yaml
rspec:
  script: test
  cache:
    paths:
P
pityonline 已提交
1063 1064
      - binaries/*.apk
      - .config
1065 1066 1067 1068 1069 1070 1071 1072
```

Locally defined cache overrides globally defined options. The following `rspec`
job will cache only `binaries/`:

```yaml
cache:
  paths:
P
pityonline 已提交
1073
    - my/files
1074 1075 1076 1077

rspec:
  script: test
  cache:
1078
    key: rspec
1079
    paths:
P
pityonline 已提交
1080
      - binaries/
1081 1082
```

1083 1084 1085 1086
Note that since cache is shared between jobs, if you're using different
paths for different jobs, you should also set a different **cache:key**
otherwise cache content can be overwritten.

E
Evan Read 已提交
1087
#### `cache:key`
1088 1089 1090

> Introduced in GitLab Runner v1.0.0.

1091 1092 1093
Since the cache is shared between jobs, if you're using different
paths for different jobs, you should also set a different `cache:key`
otherwise cache content can be overwritten.
1094

1095 1096 1097 1098
The `key` directive allows you to define the affinity of caching between jobs,
allowing to have a single cache for all jobs, cache per-job, cache per-branch
or any other way that fits your workflow. This way, you can fine tune caching,
allowing you to cache data between different jobs or even different branches.
1099 1100

The `cache:key` variable can use any of the
1101 1102 1103
[predefined variables](../variables/README.md), and the default key, if not
set, is just literal `default` which means everything is shared between each
pipelines and jobs by default, starting from GitLab 9.0.
1104 1105 1106 1107 1108

NOTE: **Note:**
The `cache:key` variable cannot contain the `/` character, or the equivalent
URI-encoded `%2F`; a value made only of dots (`.`, `%2E`) is also forbidden.

1109
For example, to enable per-branch caching:
1110 1111 1112 1113

```yaml
cache:
  key: "$CI_COMMIT_REF_SLUG"
1114
  paths:
P
pityonline 已提交
1115
    - binaries/
1116 1117
```

1118 1119
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:
1120 1121 1122

```yaml
cache:
1123
  key: "%CI_COMMIT_REF_SLUG%"
1124
  paths:
P
pityonline 已提交
1125
    - binaries/
1126 1127
```

E
Evan Read 已提交
1128
#### `cache:untracked`
1129 1130 1131

Set `untracked: true` to cache all files that are untracked in your Git
repository:
1132 1133

```yaml
1134 1135 1136 1137
rspec:
  script: test
  cache:
    untracked: true
1138 1139
```

1140
Cache all Git untracked files and files in `binaries`:
1141 1142

```yaml
1143 1144 1145 1146 1147
rspec:
  script: test
  cache:
    untracked: true
    paths:
P
pityonline 已提交
1148
      - binaries/
1149 1150
```

E
Evan Read 已提交
1151
#### `cache:policy`
1152

1153
> Introduced in GitLab 9.4.
1154

1155 1156 1157 1158
The default behaviour of a caching job is to download the files at the start of
execution, and to re-upload them at the end. This allows any changes made by the
job to be persisted for future runs, and is known as the `pull-push` cache
policy.
1159

1160 1161 1162 1163
If you know the job doesn't alter the cached files, you can skip the upload step
by setting `policy: pull` in the job specification. Typically, this would be
twinned with an ordinary cache job at an earlier stage to ensure the cache
is updated from time to time:
1164

1165 1166 1167 1168
```yaml
stages:
  - setup
  - test
1169

1170 1171 1172 1173 1174 1175 1176 1177
prepare:
  stage: setup
  cache:
    key: gems
    paths:
      - vendor/bundle
  script:
    - bundle install --deployment
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187
rspec:
  stage: test
  cache:
    key: gems
    paths:
      - vendor/bundle
    policy: pull
  script:
    - bundle exec rspec ...
1188 1189
```

1190 1191 1192
This helps to speed up job execution and reduce load on the cache server,
especially when you have a large number of cache-using jobs executing in
parallel.
1193

1194 1195 1196
Additionally, if you have a job that unconditionally recreates the cache without
reference to its previous contents, you can use `policy: push` in that job to
skip the download step.
1197

E
Evan Read 已提交
1198
### `artifacts`
K
Kamil Trzcinski 已提交
1199

1200 1201 1202 1203 1204
> - Introduced in GitLab Runner v0.7.0 for non-Windows platforms.
> - Windows support was added in GitLab Runner v.1.0.0.
> - From GitLab 9.2, caches are restored before artifacts.
> - Not all executors are [supported](https://docs.gitlab.com/runner/executors/#compatibility-chart).
> - Job artifacts are only collected for successful jobs by default.
1205

1206
`artifacts` is used to specify a list of files and directories which should be
1207
attached to the job when it [succeeds, fails, or always](#artifactswhen).
1208

1209
The artifacts will be sent to GitLab after the job finishes and will
1210
be available for download in the GitLab UI.
1211

E
Evan Read 已提交
1212
[Read more about artifacts](../../user/project/pipelines/job_artifacts.md).
1213

E
Evan Read 已提交
1214
#### `artifacts:paths`
1215

1216 1217
You can only use paths that are within the project workspace. To pass artifacts
between different jobs, see [dependencies](#dependencies).
1218

1219
Send all files in `binaries` and `.config`:
K
Kamil Trzcinski 已提交
1220

1221 1222 1223
```yaml
artifacts:
  paths:
P
pityonline 已提交
1224 1225
    - binaries/
    - .config
1226
```
K
Kamil Trzcinski 已提交
1227

1228 1229 1230 1231 1232 1233 1234 1235 1236
To disable artifact passing, define the job with empty [dependencies](#dependencies):

```yaml
job:
  stage: build
  script: make build
  dependencies: []
```

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
You may want to create artifacts only for tagged releases to avoid filling the
build server storage with temporary build artifacts.

Create artifacts only for tags (`default-job` will not create artifacts):

```yaml
default-job:
  script:
    - mvn test -U
  except:
    - tags

release-job:
  script:
    - mvn package -U
  artifacts:
    paths:
P
pityonline 已提交
1254
      - target/*.war
1255 1256 1257 1258
  only:
    - tags
```

E
Evan Read 已提交
1259
#### `artifacts:name`
1260

1261
> Introduced in GitLab 8.6 and GitLab Runner v1.1.0.
1262

A
Achilleas Pipinellis 已提交
1263
The `name` directive allows you to define the name of the created artifacts
1264
archive. That way, you can have a unique name for every archive which could be
A
Achilleas Pipinellis 已提交
1265 1266
useful when you'd like to download the archive from GitLab. The `artifacts:name`
variable can make use of any of the [predefined variables](../variables/README.md).
1267
The default name is `artifacts`, which becomes `artifacts.zip` when downloaded.
1268

1269 1270 1271 1272 1273
NOTE: **Note:**
If your branch-name contains forward slashes
(e.g. `feature/my-feature`) it is advised to use `$CI_COMMIT_REF_SLUG`
instead of `$CI_COMMIT_REF_NAME` for proper naming of the artifact.

1274
To create an archive with a name of the current job:
1275 1276 1277 1278

```yaml
job:
  artifacts:
Z
Z.J. van de Weg 已提交
1279
    name: "$CI_JOB_NAME"
1280
    paths:
P
pityonline 已提交
1281
      - binaries/
1282 1283
```

A
Achilleas Pipinellis 已提交
1284
To create an archive with a name of the current branch or tag including only
1285
the binaries directory:
1286 1287 1288

```yaml
job:
1289 1290
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
1291
    paths:
P
pityonline 已提交
1292
      - binaries/
1293 1294
```

1295
To create an archive with a name of the current job and the current branch or
1296
tag including only the binaries directory:
1297 1298 1299 1300

```yaml
job:
  artifacts:
J
John Burak 已提交
1301
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"
1302
    paths:
P
pityonline 已提交
1303
      - binaries/
1304 1305
```

A
Achilleas Pipinellis 已提交
1306
To create an archive with a name of the current [stage](#stages) and branch name:
1307 1308 1309 1310

```yaml
job:
  artifacts:
J
John Burak 已提交
1311
    name: "$CI_JOB_STAGE-$CI_COMMIT_REF_NAME"
1312
    paths:
P
pityonline 已提交
1313
      - binaries/
1314 1315
```

A
Achilleas Pipinellis 已提交
1316 1317
---

1318 1319 1320 1321 1322 1323
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:

```yaml
job:
  artifacts:
J
John Burak 已提交
1324
    name: "%CI_JOB_STAGE%-%CI_COMMIT_REF_NAME%"
1325
    paths:
P
pityonline 已提交
1326
      - binaries/
1327 1328
```

1329 1330 1331 1332 1333 1334
If you use **Windows PowerShell** to run your shell scripts you need to replace
`$` with `$env:`:

```yaml
job:
  artifacts:
J
John Burak 已提交
1335
    name: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_NAME"
1336
    paths:
P
pityonline 已提交
1337
      - binaries/
1338 1339
```

E
Evan Read 已提交
1340
#### `artifacts:untracked`
1341 1342 1343 1344 1345

`artifacts:untracked` is used to add all Git untracked files as artifacts (along
to the paths defined in `artifacts:paths`).

NOTE: **Note:**
1346
`artifacts:untracked` ignores configuration in the repository's `.gitignore` file.
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360

Send all Git untracked files:

```yaml
artifacts:
  untracked: true
```

Send all Git untracked files and files in `binaries`:

```yaml
artifacts:
  untracked: true
  paths:
P
pityonline 已提交
1361
    - binaries/
1362 1363
```

E
Evan Read 已提交
1364
#### `artifacts:when`
1365

1366
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
1367

1368
`artifacts:when` is used to upload artifacts on job failure or despite the
1369 1370 1371 1372
failure.

`artifacts:when` can be set to one of the following values:

1373 1374 1375
1. `on_success` - upload artifacts only when the job succeeds. This is the default.
1. `on_failure` - upload artifacts only when the job fails.
1. `always` - upload artifacts regardless of the job status.
1376

1377
To upload artifacts only when job fails:
1378 1379 1380 1381 1382 1383 1384

```yaml
job:
  artifacts:
    when: on_failure
```

E
Evan Read 已提交
1385
#### `artifacts:expire_in`
1386

1387
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
1388

1389 1390 1391
`expire_in` allows you to specify how long artifacts should live before they
expire and therefore deleted, counting from the time they are uploaded and
stored on GitLab. If the expiry time is not defined, it defaults to the
1392
[instance wide setting](../../user/admin_area/settings/continuous_integration.md#default-artifacts-expiration-core-only)
1393
(30 days by default, forever on GitLab.com).
1394

1395
You can use the **Keep** button on the job page to override expiration and
1396
keep artifacts forever.
1397

1398 1399
After their expiry, artifacts are deleted hourly by default (via a cron job),
and are not accessible anymore.
1400

1401 1402
The value of `expire_in` is an elapsed time in seconds, unless a unit is
provided. Examples of parsable values:
1403

1404
- '42'
1405 1406 1407 1408 1409 1410 1411
- '3 mins 4 sec'
- '2 hrs 20 min'
- '2h20min'
- '6 mos 1 day'
- '47 yrs 6 mos and 4d'
- '3 weeks and 2 days'

1412
To expire artifacts 1 week after being uploaded:
1413 1414 1415 1416 1417 1418 1419

```yaml
job:
  artifacts:
    expire_in: 1 week
```

E
Evan Read 已提交
1420
#### `artifacts:reports`
1421 1422 1423 1424 1425 1426

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20390) in
GitLab 11.2. Requires GitLab Runner 11.2 and above.

The `reports` keyword is used for collecting test reports from jobs and
exposing them in GitLab's UI (merge requests, pipeline views). Read how to use
B
Ben Bodenmiller 已提交
1427
this with [JUnit reports](#artifactsreportsjunit).
1428 1429 1430

NOTE: **Note:**
The test reports are collected regardless of the job results (success or failure).
1431
You can use [`artifacts:expire_in`](#artifactsexpire_in) to set up an expiration
1432 1433
date for their artifacts.

1434
NOTE: **Note:**
B
Ben Bodenmiller 已提交
1435 1436 1437
If you also want the ability to browse the report output files, include the
[`artifacts:paths`](#artifactspaths) keyword.

E
Evan Read 已提交
1438
##### `artifacts:reports:junit`
1439 1440 1441 1442 1443 1444 1445

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20390) in
GitLab 11.2. Requires GitLab Runner 11.2 and above.

The `junit` report collects [JUnit XML files](https://www.ibm.com/support/knowledgecenter/en/SSQ2R2_14.1.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html)
as artifacts. Although JUnit was originally developed in Java, there are many
[third party ports](https://en.wikipedia.org/wiki/JUnit#Ports) for other
B
Ben Bodenmiller 已提交
1446
languages like JavaScript, Python, Ruby, etc.
1447

B
Ben Bodenmiller 已提交
1448
See [JUnit test reports](../junit_test_reports.md) for more details and examples.
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
Below is an example of collecting a JUnit XML file from Ruby's RSpec test tool:

```yaml
rspec:
  stage: test
  script:
  - bundle install
  - rspec --format RspecJunitFormatter --out rspec.xml
  artifacts:
    reports:
      junit: rspec.xml
```

The collected JUnit reports will be uploaded to GitLab as an artifact and will
1463
be automatically shown in merge requests.
1464 1465 1466

NOTE: **Note:**
In case the JUnit tool you use exports to multiple XML files, you can specify
1467 1468 1469 1470
multiple test report paths within a single job and they will be automatically
concatenated into a single file. Use a filename pattern (`junit: rspec-*.xml`),
an array of filenames (`junit: [rspec-1.xml, rspec-2.xml, rspec-3.xml]`), or a
combination thereof (`junit: [rspec.xml, test-results/TEST-*.xml]`).
1471

E
Evan Read 已提交
1472
##### `artifacts:reports:codequality` **[STARTER]**
O
Olivier Gonzalez 已提交
1473 1474 1475

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1476
The `codequality` report collects [CodeQuality issues](../../user/project/merge_requests/code_quality.md)
O
Olivier Gonzalez 已提交
1477 1478 1479 1480 1481
as artifacts.

The collected Code Quality report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests.

E
Evan Read 已提交
1482
##### `artifacts:reports:sast` **[ULTIMATE]**
O
Olivier Gonzalez 已提交
1483 1484 1485

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1486
The `sast` report collects [SAST vulnerabilities](../../user/application_security/sast/index.md)
O
Olivier Gonzalez 已提交
1487 1488 1489 1490 1491 1492
as artifacts.

The collected SAST report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests, pipeline view and provide data for security
dashboards.

E
Evan Read 已提交
1493
##### `artifacts:reports:dependency_scanning` **[ULTIMATE]**
O
Olivier Gonzalez 已提交
1494 1495 1496

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1497
The `dependency_scanning` report collects [Dependency Scanning vulnerabilities](../../user/application_security/dependency_scanning/index.md)
O
Olivier Gonzalez 已提交
1498 1499 1500 1501 1502 1503
as artifacts.

The collected Dependency Scanning report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests, pipeline view and provide data for security
dashboards.

E
Evan Read 已提交
1504
##### `artifacts:reports:container_scanning` **[ULTIMATE]**
O
Olivier Gonzalez 已提交
1505 1506 1507

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1508
The `container_scanning` report collects [Container Scanning vulnerabilities](../../user/application_security/container_scanning/index.md)
O
Olivier Gonzalez 已提交
1509 1510 1511 1512 1513 1514
as artifacts.

The collected Container Scanning report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests, pipeline view and provide data for security
dashboards.

E
Evan Read 已提交
1515
##### `artifacts:reports:dast` **[ULTIMATE]**
O
Olivier Gonzalez 已提交
1516 1517 1518

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1519
The `dast` report collects [DAST vulnerabilities](../../user/application_security/dast/index.md)
O
Olivier Gonzalez 已提交
1520 1521 1522 1523 1524 1525
as artifacts.

The collected DAST report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests, pipeline view and provide data for security
dashboards.

E
Evan Read 已提交
1526
##### `artifacts:reports:license_management` **[ULTIMATE]**
O
Olivier Gonzalez 已提交
1527 1528 1529

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1530
The `license_management` report collects [Licenses](../../user/project/merge_requests/license_management.md)
O
Olivier Gonzalez 已提交
1531 1532 1533 1534 1535 1536
as artifacts.

The collected License Management report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests, pipeline view and provide data for security
dashboards.

E
Evan Read 已提交
1537
##### `artifacts:reports:performance` **[PREMIUM]**
O
Olivier Gonzalez 已提交
1538 1539 1540

> Introduced in GitLab 11.5. Requires GitLab Runner 11.5 and above.

1541
The `performance` report collects [Performance metrics](../../user/project/merge_requests/browser_performance_testing.md)
O
Olivier Gonzalez 已提交
1542 1543 1544 1545 1546
as artifacts.

The collected Performance report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests.

M
Marcel Amirault 已提交
1547 1548
##### `artifacts:reports:metrics` **[PREMIUM]**

1549 1550
> Introduced in GitLab 11.10.

M
Marcel Amirault 已提交
1551 1552 1553 1554 1555 1556
The `metrics` report collects [Metrics](../../ci/metrics_reports.md)
as artifacts.

The collected Metrics report will be uploaded to GitLab as an artifact and will
be automatically shown in merge requests.

E
Evan Read 已提交
1557
### `dependencies`
1558

1559
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
1560

1561
This feature should be used in conjunction with [`artifacts`](#artifacts) and
1562
allows you to define the artifacts to pass between different jobs.
1563

1564
Note that `artifacts` from all previous [stages](#stages) are passed by default.
1565

1566
To use this feature, define `dependencies` in context of the job and pass
1567 1568
a list of all previous jobs from which the artifacts should be downloaded.
You can only define jobs from stages that are executed before the current one.
S
Shinya Maeda 已提交
1569
An error will be shown if you define jobs from the current stage or next ones.
1570
Defining an empty array will skip downloading any artifacts for that job.
F
Fabio Busatto 已提交
1571 1572
The status of the previous job is not considered when using `dependencies`, so
if it failed or it is a manual job that was not run, no error occurs.
1573 1574

---
1575

1576 1577 1578 1579 1580
In the following example, we define two jobs with artifacts, `build:osx` and
`build:linux`. When the `test:osx` is executed, the artifacts from `build:osx`
will be downloaded and extracted in the context of the build. The same happens
for `test:linux` and artifacts from `build:linux`.

1581
The job `deploy` will download artifacts from all previous jobs because of
1582
the [stage](#stages) precedence:
1583

1584
```yaml
1585 1586
build:osx:
  stage: build
1587
  script: make build:osx
1588 1589
  artifacts:
    paths:
P
pityonline 已提交
1590
      - binaries/
1591

1592 1593
build:linux:
  stage: build
1594
  script: make build:linux
1595 1596
  artifacts:
    paths:
P
pityonline 已提交
1597
      - binaries/
1598 1599 1600

test:osx:
  stage: test
1601
  script: make test:osx
1602
  dependencies:
P
pityonline 已提交
1603
    - build:osx
1604 1605 1606

test:linux:
  stage: test
1607
  script: make test:linux
1608
  dependencies:
P
pityonline 已提交
1609
    - build:linux
1610 1611 1612

deploy:
  stage: deploy
1613
  script: make deploy
1614 1615
```

E
Evan Read 已提交
1616
#### When a dependent job will fail
1617 1618

> Introduced in GitLab 10.3.
S
Shinya Maeda 已提交
1619

1620
If the artifacts of the job that is set as a dependency have been
1621
[expired](#artifactsexpire_in) or
1622 1623
[erased](../../user/project/pipelines/job_artifacts.md#erasing-artifacts), then
the dependent job will fail.
S
Shinya Maeda 已提交
1624

1625 1626 1627 1628
NOTE: **Note:**
You can ask your administrator to
[flip this switch](../../administration/job_artifacts.md#validation-for-dependencies)
and bring back the old behavior.
S
Shinya Maeda 已提交
1629

E
Evan Read 已提交
1630
### `coverage`
1631

1632
> [Introduced][ce-7447] in GitLab 8.17.
1633

1634 1635
`coverage` allows you to configure how code coverage will be extracted from the
job output.
1636

1637 1638 1639 1640 1641 1642
Regular expressions are the only valid kind of value expected here. So, using
surrounding `/` is mandatory in order to consistently and explicitly represent
a regular expression string. You must escape special characters if you want to
match them literally.

A simple example:
1643 1644 1645

```yaml
job1:
1646
  script: rspec
M
Max Raab 已提交
1647
  coverage: '/Code coverage: \d+\.\d+/'
1648 1649
```

E
Evan Read 已提交
1650
### `retry`
1651

G
George Tsiolis 已提交
1652
> [Introduced][ce-12909] in GitLab 9.5.
M
Markus Doits 已提交
1653 1654
> [Behaviour expanded](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21758)
> in GitLab 11.5 to control on which failures to retry.
1655 1656 1657 1658

`retry` allows you to configure how many times a job is going to be retried in
case of a failure.

M
Markus Doits 已提交
1659
When a job fails and has `retry` configured, it is going to be processed again
1660 1661
up to the amount of times specified by the `retry` keyword.

1662
If `retry` is set to 2, and a job succeeds in a second run (first retry), it won't be retried
1663
again. `retry` value has to be a positive integer, equal or larger than 0, but
1664
lower or equal to 2 (two retries maximum, three runs in total).
1665

1666
A simple example to retry in all failure cases:
1667 1668 1669 1670

```yaml
test:
  script: rspec
1671
  retry: 2
1672 1673
```

M
Markus Doits 已提交
1674
By default, a job will be retried on all failure cases. To have a better control
T
Takuya Noguchi 已提交
1675
on which failures to retry, `retry` can be a hash with the following keys:
M
Markus Doits 已提交
1676 1677 1678

- `max`: The maximum number of retries.
- `when`: The failure cases to retry.
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689

To retry only runner system failures at maximum two times:

```yaml
test:
  script: rspec
  retry:
    max: 2
    when: runner_system_failure
```

M
Markus Doits 已提交
1690 1691
If there is another failure, other than a runner system failure, the job will
not be retried.
1692

M
Markus Doits 已提交
1693
To retry on multiple failure cases, `when` can also be an array of failures:
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706

```yaml
test:
  script: rspec
  retry:
    max: 2
    when:
      - runner_system_failure
      - stuck_or_timeout_failure
```

Possible values for `when` are:

1707 1708
<!--
  Please make sure to update `RETRY_WHEN_IN_DOCUMENTATION` array in
1709
  `spec/lib/gitlab/ci/config/entry/retry_spec.rb` if you change any of
1710 1711 1712 1713 1714
  the documented values below. The test there makes sure that all documented
  values are really valid as a config option and therefore should always
  stay in sync with this documentation.
 -->

M
Markus Doits 已提交
1715 1716 1717
- `always`: Retry on any failure (default).
- `unknown_failure`: Retry when the failure reason is unknown.
- `script_failure`: Retry when the script failed.
M
Markus Doits 已提交
1718
- `api_failure`: Retry on API failure.
M
Markus Doits 已提交
1719 1720 1721 1722
- `stuck_or_timeout_failure`: Retry when the job got stuck or timed out.
- `runner_system_failure`: Retry if there was a runner system failure (e.g. setting up the job failed).
- `missing_dependency_failure`: Retry if a dependency was missing.
- `runner_unsupported`: Retry if the runner was unsupported.
1723

E
Evan Read 已提交
1724
### `parallel`
M
Matija Čupić 已提交
1725

M
Matija Čupić 已提交
1726
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22631) in GitLab 11.5.
M
Matija Čupić 已提交
1727

M
Matija Čupić 已提交
1728
`parallel` allows you to configure how many instances of a job to run in
B
BM5k 已提交
1729
parallel. This value has to be greater than or equal to two (2) and less than or equal to 50.
M
Matija Čupić 已提交
1730

M
Matija Čupić 已提交
1731
This creates N instances of the same job that run in parallel. They're named
M
Matija Čupić 已提交
1732 1733
sequentially from `job_name 1/N` to `job_name N/N`.

1734
For every job, `CI_NODE_INDEX` and `CI_NODE_TOTAL` [environment variables](../variables/README.md#predefined-environment-variables) are set.
M
Matija Čupić 已提交
1735 1736 1737 1738 1739 1740 1741 1742 1743

A simple example:

```yaml
test:
  script: rspec
  parallel: 5
```

E
Evan Read 已提交
1744 1745 1746 1747 1748 1749 1750 1751
### `trigger` **[PREMIUM]**

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8997) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.8.

`trigger` allows you to define downstream pipeline trigger. When a job created
from `trigger` definition is started by GitLab, a downstream pipeline gets
created.

M
Marcel Amirault 已提交
1752
Learn more about [multi-project pipelines](../multi_project_pipelines.md#creating-multi-project-pipelines-from-gitlab-ciyml).
E
Evan Read 已提交
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786

#### Simple `trigger` syntax

The most simple way to configure a downstream trigger to use `trigger` keyword
with a full path to a downstream project:

```yaml
rspec:
  stage: test
  script: bundle exec rspec

staging:
  stage: deploy
  trigger: my/deployment
```

#### Complex `trigger` syntax

It is possible to configure a branch name that GitLab will use to create
a downstream pipeline with:

```yaml
rspec:
  stage: test
  script: bundle exec rspec

staging:
  stage: deploy
  trigger:
    project: my/deployment
    branch: stable
```

### `include`
1787

1788 1789
> - Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.5.
> - Available for Starter, Premium and Ultimate since 10.6.
E
Evan Read 已提交
1790
> - [Moved](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21603) to GitLab Core in 11.4.
1791 1792

Using the `include` keyword, you can allow the inclusion of external YAML files.
1793 1794
`include` requires the external YAML file to have the extensions `.yml` or `.yaml`,
otherwise the external file will not be included.
1795

1796
The files defined in `include` are:
1797

1798 1799 1800
- Deep merged with those in `.gitlab-ci.yml`.
- Always evaluated first and merged with the content of `.gitlab-ci.yml`,
  regardless of the position of the `include` keyword.
1801

1802 1803 1804
TIP: **Tip:**
Use merging to customize and override included CI/CD configurations with local
definitions.
1805

1806 1807 1808 1809
NOTE: **Note:**
Using YAML aliases across different YAML files sourced by `include` is not
supported. You must only refer to aliases in the same file. Instead
of using YAML anchors, you can use the [`extends` keyword](#extends).
1810

1811
`include` supports four include methods:
1812

1813 1814 1815 1816
- [`local`](#includelocal)
- [`file`](#includefile)
- [`template`](#includetemplate)
- [`remote`](#includeremote)
D
Daniel Fernau 已提交
1817

1818
See [usage examples](#include-examples).
1819

E
Evan Read 已提交
1820 1821 1822 1823 1824
NOTE: **Note:**
`.gitlab-ci.yml` configuration included by all methods is evaluated at pipeline creation.
The configuration is a snapshot in time and persisted in the database. Any changes to
referenced `.gitlab-ci.yml` configuration will not be reflected in GitLab until the next pipeline is created.

E
Evan Read 已提交
1825
#### `include:local`
1826

1827 1828
`include:local` includes a file from the same repository as `.gitlab-ci.yml`.
It's referenced using full paths relative to the root directory (`/`).
1829

1830 1831 1832 1833
You can only use files that are currently tracked by Git on the same branch
your configuration file is on. In other words, when using a `include:local`, make
sure that both `.gitlab-ci.yml` and the local file are on the same branch.

1834 1835 1836
All [nested includes](#nested-includes) will be executed in the scope of the same project,
so it is possible to use local, project, remote or template includes.

1837 1838 1839 1840
NOTE: **Note:**
Including local files through Git submodules paths is not supported.

Example:
K
Kamil Trzciński 已提交
1841

1842
```yaml
K
Kamil Trzciński 已提交
1843
include:
1844
  - local: '/templates/.gitlab-ci-template.yml'
K
Kamil Trzciński 已提交
1845 1846
```

E
Evan Read 已提交
1847
#### `include:file`
1848

1849
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/53903) in GitLab 11.7.
1850

1851 1852 1853 1854 1855
To include files from another private project under the same GitLab instance,
use `include:file`. This file is referenced using full  paths relative to the
root directory (`/`). For example:

```yaml
1856
include:
1857 1858
  - project: 'my-group/my-project'
    file: '/templates/.gitlab-ci-template.yml'
1859 1860
```

1861
You can also specify `ref`, with the default being the `HEAD` of the project:
K
Kamil Trzciński 已提交
1862

1863
```yaml
K
Kamil Trzciński 已提交
1864
include:
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
  - project: 'my-group/my-project'
    ref: master
    file: '/templates/.gitlab-ci-template.yml'

  - project: 'my-group/my-project'
    ref: v1.0.0
    file: '/templates/.gitlab-ci-template.yml'

  - project: 'my-group/my-project'
    ref: 787123b47f14b552955ca2786bc9542ae66fee5b # Git SHA
    file: '/templates/.gitlab-ci-template.yml'
K
Kamil Trzciński 已提交
1876 1877
```

E
Evan Read 已提交
1878
All [nested includes](#nested-includes) will be executed in the scope of the target project,
1879
so it is possible to use local (relative to target project), project, remote
1880 1881
or template includes.

E
Evan Read 已提交
1882
#### `include:template`
1883 1884 1885 1886 1887 1888 1889

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/53445) in GitLab 11.7.

`include:template` can be used to include `.gitlab-ci.yml` templates that are
[shipped with GitLab](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/gitlab/ci/templates).

For example:
K
Kamil Trzciński 已提交
1890

1891 1892
```yaml
# File sourced from GitLab's template collection
K
Kamil Trzciński 已提交
1893 1894 1895 1896
include:
  - template: Auto-DevOps.gitlab-ci.yml
```

E
Evan Read 已提交
1897
All [nested includes](#nested-includes) will be executed only with the permission of the user,
1898 1899
so it is possible to use project, remote or template includes.

E
Evan Read 已提交
1900
#### `include:remote`
1901

1902 1903 1904 1905
`include:remote` can be used to include a file from a different location,
using HTTP/HTTPS, referenced by using the full URL. The remote file must be
publicly accessible through a simple GET request as authentication schemas
in the remote URL is not supported. For example:
1906

1907 1908 1909 1910
```yaml
include:
  - remote: 'https://gitlab.com/awesome-project/raw/master/.gitlab-ci-template.yml'
```
1911

1912 1913 1914
All nested includes will be executed without context as public user, so only another remote,
or public project, or template is allowed.

E
Evan Read 已提交
1915
#### Nested includes
1916

1917
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/56836) in GitLab 11.9.
1918 1919 1920 1921

Nested includes allow you to compose a set of includes.
A total of 50 includes is allowed.
Duplicate includes are considered a configuration error.
1922

E
Evan Read 已提交
1923
#### `include` examples
K
Kamil Trzciński 已提交
1924

1925
Here are a few more `include` examples.
K
Kamil Trzciński 已提交
1926

E
Evan Read 已提交
1927
##### Single string or array of multiple values
1928

1929 1930
You can include your extra YAML file(s) either as a single string or
an array of multiple values. The following examples are all valid.
1931

1932
Single string with the `include:local` method implied:
1933

1934 1935 1936
```yaml
include: '/templates/.after-script-template.yml'
```
1937

1938
Array with `include` method implied:
1939

1940 1941 1942 1943 1944 1945 1946
```yaml
include:
  - 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
  - '/templates/.after-script-template.yml'
```

Single string with `include` method specified explicitly:
1947

1948 1949 1950 1951
```yaml
include:
  remote: 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
```
1952

1953
Array with `include:remote` being the single item:
1954

1955 1956 1957 1958
```yaml
include:
  - remote: 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
```
1959

1960
Array with multiple `include` methods specified explicitly:
1961

1962 1963 1964 1965 1966 1967
```yaml
include:
  - remote: 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
  - local: '/templates/.after-script-template.yml'
  - template: Auto-DevOps.gitlab-ci.yml
```
K
Kamil Trzciński 已提交
1968

1969
Array mixed syntax:
K
Kamil Trzciński 已提交
1970

1971 1972 1973 1974 1975 1976 1977 1978 1979
```yaml
include:
  - 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
  - '/templates/.after-script-template.yml'
  - template: Auto-DevOps.gitlab-ci.yml
  - project: 'my-group/my-project'
    ref: master
    file: '/templates/.gitlab-ci-template.yml'
```
1980

E
Evan Read 已提交
1981
##### Re-using a `before_script` template
1982

1983 1984
In the following example, the content of `.before-script-template.yml` will be
automatically fetched and evaluated along with the content of `.gitlab-ci.yml`.
K
Kamil Trzciński 已提交
1985

1986
Content of `https://gitlab.com/awesome-project/raw/master/.before-script-template.yml`:
K
Kamil Trzciński 已提交
1987

1988 1989 1990 1991 1992 1993
```yaml
before_script:
  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
  - gem install bundler --no-document
  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
```
K
Kamil Trzciński 已提交
1994

1995
Content of `.gitlab-ci.yml`:
1996

1997 1998
```yaml
include: 'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml'
1999

2000 2001 2002 2003
rspec:
  script:
    - bundle exec rspec
```
2004

E
Evan Read 已提交
2005
##### Overriding external template values
2006

2007 2008 2009
The following example shows specific YAML-defined variables and details of the
`production` job from an include file being customized in `.gitlab-ci.yml`.

2010
Content of `https://company.com/autodevops-template.yml`:
2011

2012
```yaml
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
variables:
  POSTGRES_USER: user
  POSTGRES_PASSWORD: testing_password
  POSTGRES_DB: $CI_ENVIRONMENT_SLUG

production:
  stage: production
  script:
    - install_dependencies
    - deploy
  environment:
    name: production
2025
    url: https://$CI_PROJECT_PATH_SLUG.$KUBE_INGRESS_BASE_DOMAIN
2026 2027 2028 2029
  only:
    - master
```

2030
Content of `.gitlab-ci.yml`:
2031

2032
```yaml
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
include: 'https://company.com/autodevops-template.yml'

image: alpine:latest

variables:
  POSTGRES_USER: root
  POSTGRES_PASSWORD: secure_password

stages:
  - build
  - test
  - production

production:
  environment:
    url: https://domain.com
```

In this case, the variables `POSTGRES_USER` and `POSTGRES_PASSWORD` along
with the environment url of the `production` job defined in
`autodevops-template.yml` have been overridden by new values defined in
`.gitlab-ci.yml`.

2056
The merging lets you extend and override dictionary mappings, but
2057 2058
you cannot add or modify items to an included array. For example, to add
an additional item to the production job script, you must repeat the
2059
existing script items:
2060

2061
Content of `https://company.com/autodevops-template.yml`:
2062

2063
```yaml
2064 2065 2066 2067 2068 2069 2070
production:
  stage: production
  script:
    - install_dependencies
    - deploy
```

2071
Content of `.gitlab-ci.yml`:
2072

2073
```yaml
2074 2075 2076 2077 2078 2079 2080
include: 'https://company.com/autodevops-template.yml'

stages:
  - production

production:
  script:
2081
    - install_dependencies
2082 2083 2084 2085 2086 2087 2088 2089
    - deploy
    - notify_owner
```

In this case, if `install_dependencies` and `deploy` were not repeated in
`.gitlab-ci.yml`, they would not be part of the script for the `production`
job in the combined CI configuration.

E
Evan Read 已提交
2090
##### Using nested includes
2091 2092 2093 2094 2095 2096 2097

The examples below show how includes can be nested from different sources
using a combination of different methods.

In this example, `.gitlab-ci.yml` includes local the file `/.gitlab-ci/another-config.yml`:

```yaml
L
Laurens Stötzel 已提交
2098
include:
2099 2100 2101 2102 2103 2104 2105
  - local: /.gitlab-ci/another-config.yml
```

The `/.gitlab-ci/another-config.yml` includes a template and the `/templates/docker-workflow.yml` file
from another project:

```yaml
L
Laurens Stötzel 已提交
2106
include:
2107
  - template: Bash.gitlab-ci.yml
A
Aaron Brülisauer 已提交
2108
  - project: group/my-project
2109 2110 2111
    file: /templates/docker-workflow.yml
```

E
Evan Read 已提交
2112 2113
The `/templates/docker-workflow.yml` present in `group/my-project` includes two local files
of the `group/my-project`:
2114 2115

```yaml
L
Laurens Stötzel 已提交
2116
include:
2117 2118
  - local: /templates/docker-build.yml
  - local: /templates/docker-testing.yml
2119 2120
```

E
Evan Read 已提交
2121
Our `/templates/docker-build.yml` present in `group/my-project` adds a `docker-build` job:
2122 2123 2124 2125 2126 2127

```yaml
docker-build:
  script: docker build -t my-image .
```

E
Evan Read 已提交
2128
Our second `/templates/docker-test.yml` present in `group/my-project` adds a `docker-test` job:
2129 2130 2131 2132 2133 2134

```yaml
docker-test:
  script: docker run my-image /run/tests.sh
```

E
Evan Read 已提交
2135
### `extends`
2136 2137 2138

> Introduced in GitLab 11.3.

W
Wolphin 已提交
2139
`extends` defines entry names that a job that uses `extends` is going to
2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
inherit from.

It is an alternative to using [YAML anchors](#anchors) and is a little
more flexible and readable:

```yaml
.tests:
  script: rake test
  stage: test
  only:
    refs:
      - branches

rspec:
  extends: .tests
  script: rake rspec
  only:
    variables:
      - $RSPEC
```

In the example above, the `rspec` job inherits from the `.tests` template job.
GitLab will perform a reverse deep merge based on the keys. GitLab will:

- Merge the `rspec` contents into `.tests` recursively.
- Not merge the values of the keys.

This results in the following `rspec` job:

```yaml
rspec:
  script: rake rspec
  stage: test
  only:
    refs:
      - branches
    variables:
      - $RSPEC
```

2180
NOTE: **Note:**
2181 2182
Note that `script: rake test` has been overwritten by `script: rake rspec`.

E
Evan Read 已提交
2183
If you do want to include the `rake test`, see [`before_script` and `after_script`](#before_script-and-after_script).
2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215

`.tests` in this example is a [hidden key](#hidden-keys-jobs), but it's
possible to inherit from regular jobs as well.

`extends` supports multi-level inheritance, however it is not recommended to
use more than three levels. The maximum nesting level that is supported is 10.
The following example has two levels of inheritance:

```yaml
.tests:
  only:
    - pushes

.rspec:
  extends: .tests
  script: rake rspec

rspec 1:
  variables:
    RSPEC_SUITE: '1'
  extends: .rspec

rspec 2:
  variables:
    RSPEC_SUITE: '2'
  extends: .rspec

spinach:
  extends: .tests
  script: rake spinach
```

W
Wolphin 已提交
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
It's also possible to use multiple parents for `extends`.
The algorithm used for merge is "closest scope wins", so keys
from the last member will always shadow anything defined on other levels.
For example:

```yaml
.only-important:
  only:
    - master
    - stable
  tags:
    - production

.in-docker:
  tags:
    - docker
  image: alpine

rspec:
  extends:
    - .only-important
    - .in-docker
  script:
    - rake rspec
```

This results in the following `rspec` job:

```yaml
rspec:
  only:
    - master
    - stable
  tags:
    - docker
  image: alpine
  script:
    - rake rspec
```

E
Evan Read 已提交
2256
### Using `extends` and `include` together
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280

`extends` works across configuration files combined with `include`.

For example, if you have a local `included.yml` file:

```yaml
.template:
  script:
    - echo Hello!
```

Then, in `.gitlab-ci.yml` you can use it like this:

```yaml
include: included.yml

useTemplate:
  image: alpine
  extends: .template
```

This will run a job called `useTemplate` that runs `echo Hello!` as defined in
the `.template` job, and uses the `alpine` Docker image as defined in the local job.

E
Evan Read 已提交
2281
### `pages`
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308

`pages` is a special job that is used to upload static content to GitLab that
can be used to serve your website. It has a special syntax, so the two
requirements below must be met:

- Any static content must be placed under a `public/` directory.
- `artifacts` with a path to the `public/` directory must be defined.

The example below simply moves all files from the root of the project to the
`public/` directory. The `.public` workaround is so `cp` doesn't also copy
`public/` to itself in an infinite loop:

```yaml
pages:
  stage: deploy
  script:
    - mkdir .public
    - cp -r * .public
    - mv .public public
  artifacts:
    paths:
      - public
  only:
    - master
```

Read more on [GitLab Pages user documentation](../../user/project/pages/index.md).
2309

E
Evan Read 已提交
2310
### `variables`
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335

> Introduced in GitLab Runner v0.5.0.

NOTE: **Note:**
Integers (as well as strings) are legal both for variable's name and value.
Floats are not legal and cannot be used.

GitLab CI/CD allows you to define variables inside `.gitlab-ci.yml` that are
then passed in the job environment. They can be set globally and per-job.
When the `variables` keyword is used on a job level, it overrides the global
YAML variables and predefined ones.

They are stored in the Git repository and are meant to store non-sensitive
project configuration, for example:

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

These variables can be later used in all executed commands and scripts.
The YAML-defined variables are also set to all created service containers,
thus allowing to fine tune them.

Except for the user defined variables, there are also the ones [set up by the
E
Evan Read 已提交
2336
Runner itself](../variables/README.md#predefined-environment-variables).
2337 2338 2339
One example would be `CI_COMMIT_REF_NAME` which has the value of
the branch or tag name for which project is built. Apart from the variables
you can set in `.gitlab-ci.yml`, there are also the so called
2340
[Variables](../variables/README.md#gitlab-cicd-environment-variables)
2341 2342
which can be set in GitLab's UI.

E
Evan Read 已提交
2343
Learn more about [variables and their priority][variables].
2344

E
Evan Read 已提交
2345
#### Git strategy
M
Mark Pundsack 已提交
2346

E
Evan Read 已提交
2347 2348 2349
> Introduced in GitLab 8.9 as an experimental feature. May change or be removed
> completely in future releases. `GIT_STRATEGY=none` requires GitLab Runner
> v1.7+.
N
Nick Thomas 已提交
2350 2351

You can set the `GIT_STRATEGY` used for getting recent application code, either
2352 2353
globally or per-job in the [`variables`](#variables) section. If left
unspecified, the default from project settings will be used.
M
Mark Pundsack 已提交
2354

N
Nick Thomas 已提交
2355 2356 2357 2358
There are three possible values: `clone`, `fetch`, and `none`.

`clone` is the slowest option. It clones the repository from scratch for every
job, ensuring that the project workspace is always pristine.
M
Mark Pundsack 已提交
2359

2360
```yaml
M
Mark Pundsack 已提交
2361 2362 2363 2364
variables:
  GIT_STRATEGY: clone
```

N
Nick Thomas 已提交
2365 2366 2367
`fetch` is faster as it re-uses the project workspace (falling back to `clone`
if it doesn't exist). `git clean` is used to undo any changes made by the last
job, and `git fetch` is used to retrieve commits made since the last job ran.
M
Mark Pundsack 已提交
2368

2369
```yaml
M
Mark Pundsack 已提交
2370 2371 2372 2373
variables:
  GIT_STRATEGY: fetch
```

N
Nick Thomas 已提交
2374 2375 2376 2377 2378 2379
`none` also re-uses the project workspace, but skips all Git operations
(including GitLab Runner's pre-clone script, if present). It is mostly useful
for jobs that operate exclusively on artifacts (e.g., `deploy`). Git repository
data may be present, but it is certain to be out of date, so you should only
rely on files brought into the project workspace from cache or artifacts.

2380
```yaml
N
Nick Thomas 已提交
2381 2382 2383 2384
variables:
  GIT_STRATEGY: none
```

2385
NOTE: **Note:** `GIT_STRATEGY` is not supported for
E
Evan Read 已提交
2386 2387
[Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html),
but may be in the future. See the [support Git strategy with Kubernetes executor feature proposal](https://gitlab.com/gitlab-org/gitlab-runner/issues/3847)
2388 2389
for updates.

E
Evan Read 已提交
2390
#### Git submodule strategy
2391 2392 2393 2394

> Requires GitLab Runner v1.10+.

The `GIT_SUBMODULE_STRATEGY` variable is used to control if / how Git
2395 2396
submodules are included when fetching the code before a build. You can set them
globally or per-job in the [`variables`](#variables) section.
2397

2398
There are three possible values: `none`, `normal`, and `recursive`:
2399 2400 2401 2402 2403 2404

- `none` means that submodules will not be included when fetching the project
  code. This is the default, which matches the pre-v1.10 behavior.

- `normal` means that only the top-level submodules will be included. It is
  equivalent to:
2405

2406
    ```
2407 2408
    git submodule sync
    git submodule update --init
2409 2410 2411
    ```

- `recursive` means that all submodules (including submodules of submodules)
2412 2413 2414
  will be included. This feature needs Git v1.8.1 and later. When using a
  GitLab Runner with an executor not based on Docker, make sure the Git version
  meets that requirement. It is equivalent to:
2415

2416
    ```
2417 2418
    git submodule sync --recursive
    git submodule update --init --recursive
2419 2420 2421 2422
    ```

Note that for this feature to work correctly, the submodules must be configured
(in `.gitmodules`) with either:
2423

2424 2425 2426 2427
- the HTTP(S) URL of a publicly-accessible repository, or
- a relative path to another repository on the same GitLab server. See the
  [Git submodules](../git_submodules.md) documentation.

E
Evan Read 已提交
2428
#### Git checkout
2429

E
Evan Read 已提交
2430
> Introduced in GitLab Runner 9.3.
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452

The `GIT_CHECKOUT` variable can be used when the `GIT_STRATEGY` is set to either
`clone` or `fetch` to specify whether a `git checkout` should be run. If not
specified, it defaults to true. You can set them globally or per-job in the
[`variables`](#variables) section.

If set to `false`, the Runner will:

- when doing `fetch` - update the repository and leave working copy on
  the current revision,
- when doing `clone` - clone the repository and leave working copy on the
  default branch.

Having this setting set to `true` will mean that for both `clone` and `fetch`
strategies the Runner will checkout the working copy to a revision related
to the CI pipeline:

```yaml
variables:
  GIT_STRATEGY: clone
  GIT_CHECKOUT: "false"
script:
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
  - git checkout -B master origin/master
  - git merge $CI_COMMIT_SHA
```

#### Git clean flags

> Introduced in GitLab Runner 11.10

The `GIT_CLEAN_FLAGS` variable is used to control the default behavior of
`git clean` after checking out the sources. You can set it globally or per-job in the
[`variables`](#variables) section.

`GIT_CLEAN_FLAGS` accepts all possible options of the [git clean](https://git-scm.com/docs/git-clean)
command.

`git clean` is disabled if `GIT_CHECKOUT: "false"` is specified.

If `GIT_CLEAN_FLAGS` is:

- Not specified, `git clean` flags default to `-ffdx`.
- Given the value `none`, `git clean` is not executed.

For example:

```yaml
variables:
  GIT_CLEAN_FLAGS: -ffdx -e cache/
script:
  - ls -al cache/
2482
```
2483

E
Evan Read 已提交
2484
#### Job stages attempts
2485 2486 2487

> Introduced in GitLab, it requires GitLab Runner v1.9+.

2488
You can set the number for attempts the running job will try to execute each
2489 2490
of the following stages:

2491 2492 2493 2494 2495
| Variable                        | Description |
|-------------------------------- |-------------|
| **GET_SOURCES_ATTEMPTS**        | Number of attempts to fetch sources running a job |
| **ARTIFACT_DOWNLOAD_ATTEMPTS**  | Number of attempts to download artifacts running a job |
| **RESTORE_CACHE_ATTEMPTS**      | Number of attempts to restore the cache running a job |
2496 2497 2498 2499 2500

The default is one single attempt.

Example:

2501
```yaml
2502
variables:
2503
  GET_SOURCES_ATTEMPTS: 3
2504 2505
```

2506
You can set them globally or per-job in the [`variables`](#variables) section.
2507

E
Evan Read 已提交
2508
#### Shallow cloning
M
Mark Pundsack 已提交
2509

2510
> Introduced in GitLab 8.9 as an experimental feature. May change in future
M
Mark Pundsack 已提交
2511
releases or be removed completely.
M
Mark Pundsack 已提交
2512 2513

You can specify the depth of fetching and cloning using `GIT_DEPTH`. This allows
M
Mark Pundsack 已提交
2514 2515 2516
shallow cloning of the repository which can significantly speed up cloning for
repositories with a large number of commits or old, large binaries. The value is
passed to `git fetch` and `git clone`.
M
Mark Pundsack 已提交
2517

E
Evan Read 已提交
2518
NOTE: **Note:**
2519 2520
If you use a depth of 1 and have a queue of jobs or retry
jobs, jobs may fail.
M
Mark Pundsack 已提交
2521

2522 2523 2524 2525
Since Git fetching and cloning is based on a ref, such as a branch name, Runners
can't clone a specific commit SHA. If there are multiple jobs in the queue, or
you are retrying an old job, the commit to be tested needs to be within the
Git history that is cloned. Setting too small a value for `GIT_DEPTH` can make
M
Mark Pundsack 已提交
2526
it impossible to run these old commits. You will see `unresolved reference` in
2527
job logs. You should then reconsider changing `GIT_DEPTH` to a higher value.
M
Mark Pundsack 已提交
2528

2529 2530
Jobs that rely on `git describe` may not work correctly when `GIT_DEPTH` is
set since only part of the Git history is present.
M
Mark Pundsack 已提交
2531 2532

To fetch or clone only the last 3 commits:
2533 2534

```yaml
M
Mark Pundsack 已提交
2535
variables:
M
Mark Pundsack 已提交
2536
  GIT_DEPTH: "3"
M
Mark Pundsack 已提交
2537 2538
```

2539 2540
You can set it globally or per-job in the [`variables`](#variables) section.

E
Evan Read 已提交
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
## Deprecated parameters

The following parameters are deprecated.

### `types`

CAUTION: **Deprecated:**
`types` is deprecated, and could be removed in a future release.
Use [`stages`](#stages) instead.

### `type`

CAUTION: **Deprecated:**
`type` is deprecated, and could be removed in one of the future releases.
Use [`stage`](#stage) instead.

2557 2558
## Custom build directories

A
Anthony Mastrean 已提交
2559
> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/merge_requests/1267) in Gitlab Runner 11.10
2560 2561 2562 2563 2564 2565

NOTE: **Note:**
This can only be used when `custom_build_dir` is enabled in the [Runner's
configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscustom_build_dir-section).
This is the default configuration for `docker` and `kubernetes` executor.

E
Evan Read 已提交
2566 2567 2568
By default, GitLab Runner clones the repository in a unique subpath of the
`$CI_BUILDS_DIR` directory. However, your project might require the code in a
specific directory (Go projects, for example). In that case, you can specify
A
Anthony Mastrean 已提交
2569 2570
the `GIT_CLONE_PATH` variable to tell the Runner in which directory to clone the
repository:
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622

```yml
variables:
  GIT_CLONE_PATH: $CI_BUILDS_DIR/project-name

test:
  script:
    - pwd
```

The `GIT_CLONE_PATH` has to always be within `$CI_BUILDS_DIR`. The directory set in `$CI_BUILDS_DIR`
is dependent on executor and configuration of [runners.builds_dir](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section)
setting.

### Handling concurrency

An executor using a concurrency greater than `1` might lead
to failures because multiple jobs might be working on the same directory if the `builds_dir`
is shared between jobs.
GitLab Runner does not try to prevent this situation. It is up to the administrator
and developers to comply with the requirements of Runner configuration.

To avoid this scenario, you can use a unique path within `$CI_BUILDS_DIR`, because Runner
exposes two additional variables that provide a unique `ID` of concurrency:

- `$CI_CONCURRENT_ID`: Unique ID for all jobs running within the given executor.
- `$CI_CONCURRENT_PROJECT_ID`: Unique ID for all jobs running within the given executor and project.

The most stable configuration that should work well in any scenario and on any executor
is to use `$CI_CONCURRENT_ID` in the `GIT_CLONE_PATH`. For example:

```yml
variables:
  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/project-name

test:
  script:
    - pwd
```

The `$CI_CONCURRENT_PROJECT_ID` should be used in conjunction with `$CI_PROJECT_PATH`
as the `$CI_PROJECT_PATH` provides a path of a repository. That is, `group/subgroup/project`. For example:

```yml
variables:
  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PROJECT_PATH

test:
  script:
    - pwd
```

2623 2624 2625 2626 2627 2628 2629 2630 2631
## Special YAML features

It's possible to use special YAML features like anchors (`&`), aliases (`*`)
and map merging (`<<`), which will allow you to greatly reduce the complexity
of `.gitlab-ci.yml`.

Read more about the various [YAML features](https://learnxinyminutes.com/docs/yaml/).

### Hidden keys (jobs)
A
Achilleas Pipinellis 已提交
2632

2633
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
A
Achilleas Pipinellis 已提交
2634

2635 2636 2637 2638 2639 2640 2641 2642
If you want to temporarily 'disable' a job, rather than commenting out all the
lines where the job is defined:

```
#hidden_job:
#  script:
#    - run test
```
A
Achilleas Pipinellis 已提交
2643

2644 2645
you can instead start its name with a dot (`.`) and it will not be processed by
GitLab CI. In the following example, `.hidden_job` will be ignored:
A
Achilleas Pipinellis 已提交
2646 2647

```yaml
2648
.hidden_job:
A
Achilleas Pipinellis 已提交
2649
  script:
2650
    - run test
A
Achilleas Pipinellis 已提交
2651 2652
```

2653 2654 2655
Use this feature to ignore jobs, or use the
[special YAML features](#special-yaml-features) and transform the hidden keys
into templates.
2656

2657 2658
### Anchors

2659
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
2660

2661
YAML has a handy feature called 'anchors', which lets you easily duplicate
2662
content across your document. Anchors can be used to duplicate/inherit
2663
properties, and is a perfect example to be used with [hidden keys](#hidden-keys-jobs)
2664 2665 2666 2667 2668
to provide templates for your jobs.

The following example uses anchors and map merging. It will create two jobs,
`test1` and `test2`, that will inherit the parameters of `.job_template`, each
having their own custom `script` defined:
2669 2670

```yaml
2671
.job_template: &job_definition  # Hidden key that defines an anchor named 'job_definition'
2672 2673 2674 2675 2676 2677
  image: ruby:2.1
  services:
    - postgres
    - redis

test1:
2678
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
2679
  script:
2680
    - test1 project
2681 2682

test2:
2683
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
2684
  script:
2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
    - test2 project
```

`&` sets up the name of the anchor (`job_definition`), `<<` means "merge the
given hash into the current one", and `*` includes the named anchor
(`job_definition` again). The expanded version looks like this:

```yaml
.job_template:
  image: ruby:2.1
  services:
    - postgres
    - redis

test1:
  image: ruby:2.1
  services:
    - postgres
    - redis
  script:
    - test1 project

test2:
  image: ruby:2.1
  services:
    - postgres
    - redis
  script:
    - test2 project
2714 2715
```

2716 2717 2718 2719
Let's see another one example. This time we will use anchors to define two sets
of services. This will create two jobs, `test:postgres` and `test:mysql`, that
will share the `script` directive defined in `.job_template`, and the `services`
directive defined in `.postgres_services` and `.mysql_services` respectively:
2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730

```yaml
.job_template: &job_definition
  script:
    - test project

.postgres_services:
  services: &postgres_definition
    - postgres
    - ruby

2731
.mysql_services:
2732 2733 2734 2735 2736
  services: &mysql_definition
    - mysql
    - ruby

test:postgres:
A
Achilleas Pipinellis 已提交
2737
  <<: *job_definition
2738 2739 2740
  services: *postgres_definition

test:mysql:
A
Achilleas Pipinellis 已提交
2741
  <<: *job_definition
2742 2743 2744
  services: *mysql_definition
```

2745
The expanded version looks like this:
2746

2747 2748 2749 2750
```yaml
.job_template:
  script:
    - test project
2751

2752 2753 2754 2755
.postgres_services:
  services:
    - postgres
    - ruby
2756

2757 2758 2759 2760 2761 2762
.mysql_services:
  services:
    - mysql
    - ruby

test:postgres:
2763
  script:
2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
    - test project
  services:
    - postgres
    - ruby

test:mysql:
  script:
    - test project
  services:
    - mysql
    - ruby
2775 2776
```

2777
You can see that the hidden keys are conveniently used as templates.
2778

2779 2780 2781
## Triggers

Triggers can be used to force a rebuild of a specific branch, tag or commit,
E
Evan Read 已提交
2782 2783 2784
with an API call when a pipeline gets created using a trigger token.

Not to be confused with [`trigger`](#trigger-premium).
2785 2786 2787

[Read more in the triggers documentation.](../triggers/README.md)

2788 2789 2790 2791 2792 2793 2794 2795 2796
## Processing Git pushes

GitLab will create at most 4 branch and tags pipelines when
doing pushing multiple changes in single `git push` invocation.

This limitation does not affect any of the updated Merge Request pipelines,
all updated Merge Requests will have a pipeline created when using
[pipelines for merge requests](../merge_request_pipelines/index.md).

2797
## Skipping jobs
2798

2799 2800
If your commit message contains `[ci skip]` or `[skip ci]`, using any
capitalization, the commit will be created but the pipeline will be skipped.
2801

2802 2803
Alternatively, one can pass the `ci.skip` [Git push option][push-option] if
using Git 2.10 or newer:
E
Evan Read 已提交
2804 2805 2806

```sh
git push -o ci.skip
2807 2808
```

M
Marcia Ramos 已提交
2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820
<!-- ## Troubleshooting

Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.

Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->

2821
[ce-6323]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6323
2822
[ce-6669]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6669
2823
[ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983
2824
[ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447
G
George Tsiolis 已提交
2825
[ce-12909]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12909
2826
[ce-19232]: https://gitlab.com/gitlab-org/gitlab-ce/issues/19232
2827 2828 2829
[environment]: ../environments.md "CI/CD environments"
[schedules]: ../../user/project/pipelines/schedules.md "Pipelines schedules"
[variables]: ../variables/README.md "CI/CD variables"
2830
[push-option]: https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt