README.md 27.7 KB
Newer Older
D
Douwe Maan 已提交
1 2
# Configuration of your builds with .gitlab-ci.yml

3 4 5 6 7 8 9 10
This document describes the usage of `.gitlab-ci.yml`, the file that is used by
GitLab Runner to manage your project's builds.

If you want a quick introduction to GitLab CI, follow our
[quick start guide](../quick_start/README.md).

## .gitlab-ci.yml

11 12 13 14 15 16
From version 7.12, GitLab CI uses a [YAML](https://en.wikipedia.org/wiki/YAML)
file (`.gitlab-ci.yml`) for the project configuration. It is placed in the root
of your repository and contains definitions of how your project should be built.

The YAML file defines a set of jobs with constraints stating when they should
be run. The jobs are defined as top-level elements with a name and always have
17
to contain at least the `script` clause:
D
Douwe Maan 已提交
18 19 20 21 22 23 24 25 26

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

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

27 28 29 30 31
The above example is the simplest possible CI configuration with two separate
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 已提交
32

33
Jobs are used to create builds, which are then picked up by
34 35
[Runners](../runners/README.md) and executed within the environment of the
Runner. What is important, is that each job is run independently from each
36
other.
D
Douwe Maan 已提交
37

38 39
The YAML syntax allows for using more complex job specifications than in the
above example:
D
Douwe Maan 已提交
40 41

```yaml
J
James Lopez 已提交
42
image: ruby:2.1
D
Douwe Maan 已提交
43 44 45 46
services:
  - postgres

before_script:
F
frodsan 已提交
47
  - bundle install
D
Douwe Maan 已提交
48

49 50 51
after_script:
  - rm secrets

D
Douwe Maan 已提交
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
stages:
  - build
  - test
  - deploy

job1:
  stage: build
  script:
    - execute-script-for-job1
  only:
    - master
  tags:
    - docker
```

67
There are a few reserved `keywords` that **cannot** be used as job names:
D
Douwe Maan 已提交
68

69
| Keyword       | Required | Description |
D
Douwe Maan 已提交
70
|---------------|----------|-------------|
71 72 73 74 75
| image         | no | Use docker image, covered in [Use Docker](../docker/README.md) |
| services      | no | Use docker services, covered in [Use Docker](../docker/README.md) |
| stages        | no | Define build stages |
| types         | no | Alias for `stages` |
| before_script | no | Define commands that run before each job's script |
76
| after_script  | no | Define commands that run after each job's script |
77 78
| variables     | no | Define build variables |
| cache         | no | Define list of files that should be cached between subsequent runs |
D
Douwe Maan 已提交
79 80

### image and services
81 82 83

This allows to specify a custom Docker image and a list of services that can be
used for time of the build. The configuration of this feature is covered in
84
[a separate document](../docker/README.md).
D
Douwe Maan 已提交
85 86

### before_script
87 88 89

`before_script` is used to define the command that should be run before all
builds, including deploy builds. This can be an array or a multi-line string.
D
Douwe Maan 已提交
90

91 92
### after_script

K
Kamil Trzcinski 已提交
93
>**Note:**
M
Max Raab 已提交
94
Introduced in GitLab 8.7 and requires Gitlab Runner v1.2
K
Kamil Trzcinski 已提交
95

96 97 98
`after_script` is used to define the command that will be run after for all
builds. This has to be an array or a multi-line string.

D
Douwe Maan 已提交
99
### stages
100

D
Douwe Maan 已提交
101 102 103 104 105 106
`stages` is used to define build stages that can be used by jobs.
The specification of `stages` allows for having flexible multi stage pipelines.

The ordering of elements in `stages` defines the ordering of builds' execution:

1. Builds of the same stage are run in parallel.
107 108
1. Builds of the next stage are run after the jobs from the previous stage
   complete successfully.
D
Douwe Maan 已提交
109 110

Let's consider the following example, which defines 3 stages:
111 112

```yaml
D
Douwe Maan 已提交
113 114 115 116 117 118 119
stages:
  - build
  - test
  - deploy
```

1. First all jobs of `build` are executed in parallel.
120 121 122
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.
1. If all jobs of `deploy` succeed, the commit is marked as `success`.
123 124
1. If any of the previous jobs fails, the commit is marked as `failed` and no
   jobs of further stage are executed.
D
Douwe Maan 已提交
125 126 127

There are also two edge cases worth mentioning:

128
1. If no `stages` are defined in `.gitlab-ci.yml`, then by default the `build`,
129
   `test` and `deploy` are allowed to be used as job's stage by default.
M
Mark Pundsack 已提交
130
2. If a job doesn't specify a `stage`, the job is assigned the `test` stage.
D
Douwe Maan 已提交
131 132

### types
133

D
Douwe Maan 已提交
134 135 136 137
Alias for [stages](#stages).

### variables

138 139
>**Note:**
Introduced in GitLab Runner v0.5.0.
140

M
Mark Pundsack 已提交
141
GitLab CI allows you to add variables to `.gitlab-ci.yml` that are set in the
142
build environment. The variables are stored in the Git repository and are meant
M
Mark Pundsack 已提交
143
to store non-sensitive project configuration, for example:
D
Douwe Maan 已提交
144 145 146 147 148 149 150 151

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

These variables can be later used in all executed commands and scripts.

152 153
The YAML-defined variables are also set to all created service containers,
thus allowing to fine tune them.
D
Douwe Maan 已提交
154

155 156
Variables can be also defined on [job level](#job-variables).

157 158
[Learn more about variables.](../variables/README.md)

159 160
### cache

161 162 163
>**Note:**
Introduced in GitLab Runner v0.7.0.

164
`cache` is used to specify a list of files and directories which should be
165 166 167
cached between builds.

**By default the caching is enabled per-job and per-branch.**
168 169 170

If `cache` is defined outside the scope of the jobs, it means it is set
globally and all jobs will use its definition.
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
Cache all files in `binaries` and `.config`:

```yaml
rspec:
  script: test
  cache:
    paths:
    - binaries/
    - .config
```

Cache all Git untracked files:

```yaml
rspec:
  script: test
  cache:
    untracked: true
```

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

```yaml
rspec:
  script: test
  cache:
    untracked: true
    paths:
    - binaries/
```

Locally defined cache overwrites globally defined options. This will cache only
`binaries/`:
205 206

```yaml
207 208
cache:
  paths:
209 210 211 212 213 214 215
  - my/files

rspec:
  script: test
  cache:
    paths:
    - binaries/
216 217
```

M
Mark Pundsack 已提交
218 219
The cache is provided on a best-effort basis, so don't expect that the cache
will be always present. For implementation details, please check GitLab Runner.
220

221 222
#### cache:key

223 224
>**Note:**
Introduced in GitLab Runner v1.0.0.
225 226 227 228 229

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 you deem proper.

230 231
This allows you to fine tune caching, allowing you to cache data between
different jobs or even different branches.
232

233 234 235 236 237
The `cache:key` variable can use any of the [predefined variables](../variables/README.md).

---

**Example configurations**
238 239 240

To enable per-job caching:

241 242 243 244 245
```yaml
cache:
  key: "$CI_BUILD_NAME"
  untracked: true
```
246 247 248

To enable per-branch caching:

249 250 251 252 253
```yaml
cache:
  key: "$CI_BUILD_REF_NAME"
  untracked: true
```
254 255 256

To enable per-job and per-branch caching:

257 258 259 260 261
```yaml
cache:
  key: "$CI_BUILD_NAME/$CI_BUILD_REF_NAME"
  untracked: true
```
262 263 264

To enable per-branch and per-stage caching:

265 266 267 268 269
```yaml
cache:
  key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME"
  untracked: true
```
270

271 272
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:
273

274 275 276 277 278
```yaml
cache:
  key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%"
  untracked: true
```
279

D
Douwe Maan 已提交
280
## Jobs
281 282 283 284

`.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job
must have a unique name, which is not one of the Keywords mentioned above.
A job is defined by a list of parameters that define the build behavior.
D
Douwe Maan 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301

```yaml
job_name:
  script:
    - rake spec
    - coverage
  stage: test
  only:
    - master
  except:
    - develop
  tags:
    - ruby
    - postgres
  allow_failure: true
```

302
| Keyword       | Required | Description |
D
Douwe Maan 已提交
303
|---------------|----------|-------------|
304
| script        | yes | Defines a shell script which is executed by Runner |
P
Pat Turner 已提交
305 306
| image         | no | Use docker image, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
| services      | no | Use docker services, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
307
| stage         | no | Defines a build stage (default: `test`) |
308
| type          | no | Alias for `stage` |
309
| variables     | no | Define build variables on a job level |
310 311
| only          | no | Defines a list of git refs for which build is created |
| except        | no | Defines a list of git refs for which build is not created |
312
| tags          | no | Defines a list of tags which are used to select Runner |
313
| allow_failure | no | Allow build to fail. Failed build doesn't contribute to commit status |
314
| when          | no | Define when to run build. Can be `on_success`, `on_failure`, `always` or `manual` |
315
| dependencies  | no | Define other builds that a build depends on so that you can pass artifacts between them|
A
Aurelio Jargas 已提交
316
| artifacts     | no | Define list of build artifacts |
317
| cache         | no | Define list of files that should be cached between subsequent runs |
318 319
| before_script | no | Override a set of commands that are executed before build |
| after_script  | no | Override a set of commands that are executed after build |
320
| environment   | no | Defines a name of environment to which deployment is done by this build |
D
Douwe Maan 已提交
321 322

### script
323

324
`script` is a shell script which is executed by the Runner. For example:
D
Douwe Maan 已提交
325 326 327 328 329 330 331

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

This parameter can also contain several commands using an array:
332

D
Douwe Maan 已提交
333 334 335 336 337 338 339
```yaml
job:
  script:
    - uname -a
    - bundle exec rspec
```

M
Mark Pundsack 已提交
340
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 (`:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``).
341

D
Douwe Maan 已提交
342
### stage
343 344 345 346

`stage` allows to group build into different stages. Builds of the same `stage`
are executed in `parallel`. For more info about the use of `stage` please check
[stages](#stages).
D
Douwe Maan 已提交
347 348 349

### only and except

350 351
`only` and `except` are two parameters that set a refs policy to limit when
jobs are built:
D
Douwe Maan 已提交
352

353 354 355 356 357 358 359 360 361 362
1. `only` defines the names of branches and tags for which the job will be
    built.
2. `except` defines the names of branches and tags for which the job will
    **not** be built.

There are a few rules that apply to the usage of refs policy:

* `only` and `except` are inclusive. If both `only` and `except` are defined
   in a job specification, the ref is filtered by `only` and `except`.
* `only` and `except` allow the use of regular expressions.
363
* `only` and `except` allow the use of special keywords: `branches`, `tags`, and `triggers`.
364 365 366 367 368
* `only` and `except` allow to specify a repository path to filter jobs for
   forks.

In the example below, `job` will run only for refs that start with `issue-`,
whereas all branches will be skipped.
D
Douwe Maan 已提交
369 370 371

```yaml
job:
372
  # use regexp
D
Douwe Maan 已提交
373
  only:
374 375
    - /^issue-.*$/
  # use special keyword
D
Douwe Maan 已提交
376
  except:
377
    - branches
D
Douwe Maan 已提交
378 379
```

380 381 382 383 384 385 386 387 388 389 390
In this example, `job` will run only for refs that are tagged, or if a build is explicitly requested
via an API trigger.

```yaml
job:
  # use special keywords
  only:
    - tags
    - triggers
```

391 392
The repository path can be used to have jobs executed only for the parent
repository and not forks:
393 394 395 396 397 398 399 400

```yaml
job:
  only:
    - branches@gitlab-org/gitlab-ce
  except:
    - master@gitlab-org/gitlab-ce
```
401 402 403

The above example will run `job` for all branches on `gitlab-org/gitlab-ce`,
except master.
404

405 406 407
### job variables

It is possible to define build variables using a `variables` keyword on a job
408 409
level. It works basically the same way as its global-level equivalent but
allows you to define job-specific build variables.
410

411
When the `variables` keyword is used on a job level, it overrides global YAML
412 413
build variables and predefined variables.

414 415
Build variables priority is defined in
[variables documentation](../variables/README.md).
416

D
Douwe Maan 已提交
417 418
### tags

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

422
During the registration of a Runner, you can specify the Runner's tags, for
423 424
example `ruby`, `postgres`, `development`.

425
`tags` allow you to run builds with Runners that have the specified tags
426 427 428
assigned to them:

```yaml
D
Douwe Maan 已提交
429 430 431 432 433 434
job:
  tags:
    - ruby
    - postgres
```

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

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
### allow_failure

`allow_failure` is used when you want to allow a build to fail without impacting
the rest of the CI suite. Failed builds don't contribute to the commit status.

When enabled and the build fails, the pipeline will be successful/green for all
intents and purposes, but a "CI build passed with warnings" message  will be
displayed on the merge request or commit or build page. This is to be used by
builds that are allowed to fail, but where failure indicates some other (manual)
steps should be taken elsewhere.

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:
  - execute_script_that_will_fail
  allow_failure: true

job2:
  stage: test
  script:
  - execute_script_that_will_succeed

job3:
  stage: deploy
  script:
  - deploy_to_staging
```

471
### when
472 473 474

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

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

478
1. `on_success` - execute build only when all builds from prior stages
479
    succeed. This is the default.
480
1. `on_failure` - execute build only when at least one build from prior stages
481 482
    fails.
1. `always` - execute build regardless of the status of builds from prior stages.
483 484
1. `manual` - execute build manually (added in GitLab 8.10). Read about
    [manual actions](#manual-actions) below.
485

486 487 488
For example:

```yaml
489 490 491 492 493 494 495
stages:
- build
- cleanup_build
- test
- deploy
- cleanup

496
build_job:
497 498 499 500
  stage: build
  script:
  - make build

501
cleanup_build_job:
502 503 504 505 506
  stage: cleanup_build
  script:
  - cleanup build when failed
  when: on_failure

507
test_job:
508 509 510 511
  stage: test
  script:
  - make test

512
deploy_job:
513 514 515
  stage: deploy
  script:
  - make deploy
516
  when: manual
517

518
cleanup_job:
519 520 521 522 523 524 525
  stage: cleanup
  script:
  - cleanup after builds
  when: always
```

The above script will:
526

527 528 529 530
1. Execute `cleanup_build_job` only when `build_job` fails.
2. Always execute `cleanup_job` as the last step in pipeline regardless of
   success or failure.
3. Allow you to manually execute `deploy_job` from GitLab's UI.
531 532 533 534 535 536

#### Manual actions

>**Note:**
Introduced in GitLab 8.10.

537 538 539 540
Manual actions are a special type of job that are not executed automatically;
they need to be explicitly started by a user. Manual actions can be started
from pipeline, build, environment, and deployment views. You can execute the
same manual action multiple times.
541

542
An example usage of manual actions is deployment to production.
543

544 545 546
### environment

>**Note:**
M
Mark Pundsack 已提交
547
Introduced in GitLab 8.9.
548

M
Mark Pundsack 已提交
549 550 551
`environment` is used to define that a job deploys to a specific environment.
This allows easy tracking of all deployments to your environments straight from
GitLab.
552

M
Mark Pundsack 已提交
553 554
If `environment` is specified and no environment under that name exists, a new
one will be created automatically.
555

556
The `environment` name must be a valid git reference name. Common
M
Mark Pundsack 已提交
557 558
names are `qa`, `staging`, and `production`, but you can use whatever name works
with your workflow.
559 560 561 562 563 564 565 566 567 568 569 570

---

**Example configurations**

```
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment: production
```

M
Mark Pundsack 已提交
571 572
The `deploy to production` job will be marked as doing deployment to
`production` environment.
573

574 575 576 577 578 579
#### dynamic environments

>**Note:**
Introduced in GitLab 8.12.

`environment` can also represent a configuration hash with `name` and `url`.
K
Kamil Trzcinski 已提交
580
These parameters can use any of the defined CI variables (including predefined, secure variables and `.gitlab-ci.yml` variables).
581

K
Kamil Trzcinski 已提交
582
The common use case is to create dynamic environments for branches and use them as review apps.
583 584 585 586 587 588 589 590 591 592 593 594 595 596

---

**Example configurations**

```
deploy as review app:
  stage: deploy
  script: ...
  environment: 
    name: review-apps/$CI_BUILD_REF_NAME
    url: https://$CI_BUILD_REF_NAME.review.example.com/
```

K
Kamil Trzcinski 已提交
597 598
The `deploy as review app` job will be marked as deployment to
dynamically created `review-apps/branch-name` environment.
599

K
Kamil Trzcinski 已提交
600
This environment should be accessible under `https://branch-name.review.example.com/`.
601

K
Kamil Trzcinski 已提交
602 603
### artifacts

604 605 606
>**Notes:**
>
> - Introduced in GitLab Runner v0.7.0 for non-Windows platforms.
607
> - Windows support was added in GitLab Runner v.1.0.0.
608
> - Currently not all executors are supported.
609
> - Build artifacts are only collected for successful builds by default.
610

611 612
`artifacts` is used to specify a list of files and directories which should be
attached to the build after success. To pass artifacts between different builds,
613 614 615
see [dependencies](#dependencies).

Below are some examples.
616

617
Send all files in `binaries` and `.config`:
618

619 620 621 622 623 624
```yaml
artifacts:
  paths:
  - binaries/
  - .config
```
625

626
Send all Git untracked files:
627

628 629 630 631 632
```yaml
artifacts:
  untracked: true
```

633
Send all Git untracked files and files in `binaries`:
K
Kamil Trzcinski 已提交
634

635 636 637 638 639 640
```yaml
artifacts:
  untracked: true
  paths:
  - binaries/
```
K
Kamil Trzcinski 已提交
641

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
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:
    - target/*.war
  only:
    - tags
```

664 665
The artifacts will be sent to GitLab after a successful build and will
be available for download in the GitLab UI.
K
Kamil Trzcinski 已提交
666

667 668
#### artifacts:name

669 670
>**Note:**
Introduced in GitLab 8.6 and GitLab Runner v1.1.0.
671

A
Achilleas Pipinellis 已提交
672
The `name` directive allows you to define the name of the created artifacts
673
archive. That way, you can have a unique name for every archive which could be
A
Achilleas Pipinellis 已提交
674 675
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).
676
The default name is `artifacts`, which becomes `artifacts.zip` when downloaded.
677 678 679 680 681

---

**Example configurations**

A
Achilleas Pipinellis 已提交
682
To create an archive with a name of the current build:
683 684 685 686 687 688 689

```yaml
job:
  artifacts:
    name: "$CI_BUILD_NAME"
```

A
Achilleas Pipinellis 已提交
690 691
To create an archive with a name of the current branch or tag including only
the files that are untracked by Git:
692 693 694 695 696 697 698 699

```yaml
job:
   artifacts:
     name: "$CI_BUILD_REF_NAME"
     untracked: true
```

A
Achilleas Pipinellis 已提交
700 701
To create an archive with a name of the current build and the current branch or
tag including only the files that are untracked by Git:
702 703 704 705 706 707 708 709

```yaml
job:
  artifacts:
    name: "${CI_BUILD_NAME}_${CI_BUILD_REF_NAME}"
    untracked: true
```

A
Achilleas Pipinellis 已提交
710
To create an archive with a name of the current [stage](#stages) and branch name:
711 712 713 714 715 716 717 718

```yaml
job:
  artifacts:
    name: "${CI_BUILD_STAGE}_${CI_BUILD_REF_NAME}"
    untracked: true
```

A
Achilleas Pipinellis 已提交
719 720
---

721 722 723 724 725 726 727 728 729 730
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:

```yaml
job:
  artifacts:
    name: "%CI_BUILD_STAGE%_%CI_BUILD_REF_NAME%"
    untracked: true
```

731 732 733 734 735 736 737 738 739 740
#### artifacts:when

>**Note:**
Introduced in GitLab 8.9 and GitLab Runner v1.3.0.

`artifacts:when` is used to upload artifacts on build failure or despite the
failure.

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

741 742 743
1. `on_success` - upload artifacts only when the build succeeds. This is the default.
1. `on_failure` - upload artifacts only when the build fails.
1. `always` - upload artifacts regardless of the build status.
744 745 746 747 748

---

**Example configurations**

K
Kamil Trzcinski 已提交
749
To upload artifacts only when build fails.
750 751 752 753 754 755 756

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

757 758 759 760 761
#### artifacts:expire_in

>**Note:**
Introduced in GitLab 8.9 and GitLab Runner v1.3.0.

762 763 764 765
`artifacts:expire_in` is used to delete uploaded artifacts after the specified
time. By default, artifacts are stored on GitLab forever. `expire_in` allows you
to specify how long artifacts should live before they expire, counting from the
time they are uploaded and stored on GitLab.
766

767 768
You can use the **Keep** button on the build page to override expiration and
keep artifacts forever.
769

M
Mark Pundsack 已提交
770 771
After expiry, artifacts are actually deleted hourly by default (via a cron job),
but they are not accessible after expiry.
772

773
The value of `expire_in` is an elapsed time. Examples of parseable values:
774 775 776 777 778 779 780 781 782 783 784
- '3 mins 4 sec'
- '2 hrs 20 min'
- '2h20min'
- '6 mos 1 day'
- '47 yrs 6 mos and 4d'
- '3 weeks and 2 days'

---

**Example configurations**

785
To expire artifacts 1 week after being uploaded:
786 787 788 789 790 791 792

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

793 794
### dependencies

795 796
>**Note:**
Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
797

798 799
This feature should be used in conjunction with [`artifacts`](#artifacts) and
allows you to define the artifacts to pass between different builds.
800

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

803
To use this feature, define `dependencies` in context of the job and pass
804
a list of all previous builds from which the artifacts should be downloaded.
805 806
You can only define builds from stages that are executed before the current one.
An error will be shown if you define builds from the current stage or next ones.
807
Defining an empty array will skip downloading any artifacts for that job.
808 809

---
810

811 812 813 814 815 816 817
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`.

The job `deploy` will download artifacts from all previous builds because of
the [stage](#stages) precedence:
818

819
```yaml
820 821
build:osx:
  stage: build
822
  script: make build:osx
823 824 825
  artifacts:
    paths:
    - binaries/
826

827 828
build:linux:
  stage: build
829
  script: make build:linux
830 831 832 833 834 835
  artifacts:
    paths:
    - binaries/

test:osx:
  stage: test
836
  script: make test:osx
837 838 839 840 841
  dependencies:
  - build:osx

test:linux:
  stage: test
842
  script: make test:linux
843 844 845 846 847
  dependencies:
  - build:linux

deploy:
  stage: deploy
848
  script: make deploy
849 850
```

851 852 853 854 855
### before_script and after_script

It's possible to overwrite globally defined `before_script` and `after_script`:

```yaml
P
Philipp Kraus 已提交
856
before_script:
857 858 859 860 861 862 863 864 865 866 867
- global before script

job:
  before_script:
  - execute this instead of global before script
  script:
  - my command
  after_script:
  - execute this after my script
```

M
Mark Pundsack 已提交
868 869 870
## Git Strategy

>**Note:**
M
Mark Pundsack 已提交
871 872
Introduced in GitLab 8.9 as an experimental feature. May change in future
releases or be removed completely.
M
Mark Pundsack 已提交
873 874 875

You can set the `GIT_STRATEGY` used for getting recent application code. `clone`
is slower, but makes sure you have a clean directory before every build. `fetch`
M
Mark Pundsack 已提交
876 877 878
is faster. `GIT_STRATEGY` can be specified in the global `variables` section or
in the `variables` section for individual jobs. If it's not specified, then the
default from project settings will be used.
M
Mark Pundsack 已提交
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894

```
variables:
  GIT_STRATEGY: clone
```

or

```
variables:
  GIT_STRATEGY: fetch
```

## Shallow cloning

>**Note:**
M
Mark Pundsack 已提交
895 896
Introduced in GitLab 8.9 as an experimental feature. May change in future
releases or be removed completely.
M
Mark Pundsack 已提交
897 898

You can specify the depth of fetching and cloning using `GIT_DEPTH`. This allows
M
Mark Pundsack 已提交
899 900 901
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 已提交
902

M
Mark Pundsack 已提交
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
>**Note:**
If you use a depth of 1 and have a queue of builds or retry
builds, jobs may fail.

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 builds in the queue, or
you are retrying an old build, 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
it impossible to run these old commits. You will see `unresolved reference` in
build logs. You should then reconsider changing `GIT_DEPTH` to a higher value.

Builds that rely on `git describe` may not work correctly when `GIT_DEPTH` is
set since only part of the git history is present.

To fetch or clone only the last 3 commits:
M
Mark Pundsack 已提交
918 919
```
variables:
M
Mark Pundsack 已提交
920
  GIT_DEPTH: "3"
M
Mark Pundsack 已提交
921 922
```

923
## Hidden keys
A
Achilleas Pipinellis 已提交
924 925 926 927

>**Note:**
Introduced in GitLab 8.6 and GitLab Runner v1.1.1.

928
Keys that start with a dot (`.`) will be not processed by GitLab CI. You can
A
Achilleas Pipinellis 已提交
929
use this feature to ignore jobs, or use the
930
[special YAML features](#special-yaml-features) and transform the hidden keys
A
Achilleas Pipinellis 已提交
931 932
into templates.

933
In the following example, `.key_name` will be ignored:
A
Achilleas Pipinellis 已提交
934 935

```yaml
936
.key_name:
A
Achilleas Pipinellis 已提交
937 938 939 940
  script:
    - rake spec
```

941 942 943
Hidden keys can be hashes like normal CI jobs, but you are also allowed to use
different types of structures to leverage special YAML features.

944
## Special YAML features
945

946 947 948
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`.
949

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

952 953 954 955 956 957 958
### Anchors

>**Note:**
Introduced in GitLab 8.6 and GitLab Runner v1.1.1.

YAML also has a handy feature called 'anchors', which let you easily duplicate
content across your document. Anchors can be used to duplicate/inherit
959
properties, and is a perfect example to be used with [hidden keys](#hidden-keys)
960 961 962 963 964
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:
965 966

```yaml
967
.job_template: &job_definition  # Hidden key that defines an anchor named 'job_definition'
968 969 970 971 972 973
  image: ruby:2.1
  services:
    - postgres
    - redis

test1:
974
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
975
  script:
976
    - test1 project
977 978

test2:
979
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
980
  script:
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    - 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
1010 1011
```

1012 1013 1014 1015
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:
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

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

.postgres_services:
  services: &postgres_definition
    - postgres
    - ruby

1027
.mysql_services:
1028 1029 1030 1031 1032
  services: &mysql_definition
    - mysql
    - ruby

test:postgres:
A
Achilleas Pipinellis 已提交
1033
  <<: *job_definition
1034 1035 1036
  services: *postgres_definition

test:mysql:
A
Achilleas Pipinellis 已提交
1037
  <<: *job_definition
1038 1039 1040
  services: *mysql_definition
```

1041
The expanded version looks like this:
1042

1043 1044 1045 1046
```yaml
.job_template:
  script:
    - test project
1047

1048 1049 1050 1051
.postgres_services:
  services:
    - postgres
    - ruby
1052

1053 1054 1055 1056 1057 1058
.mysql_services:
  services:
    - mysql
    - ruby

test:postgres:
1059
  script:
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    - test project
  services:
    - postgres
    - ruby

test:mysql:
  script:
    - test project
  services:
    - mysql
    - ruby
1071 1072
```

1073
You can see that the hidden keys are conveniently used as templates.
1074

1075 1076 1077 1078 1079 1080 1081
## Triggers

Triggers can be used to force a rebuild of a specific branch, tag or commit,
with an API call.

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

D
Douwe Maan 已提交
1082
## Validate the .gitlab-ci.yml
1083

D
Douwe Maan 已提交
1084
Each instance of GitLab CI has an embedded debug tool called Lint.
1085
You can find the link under `/ci/lint` of your gitlab instance.
D
Douwe Maan 已提交
1086 1087

## Skipping builds
1088

S
Simon Welsh 已提交
1089 1090
If your commit message contains `[ci skip]` or `[skip ci]`, using any
capitalization, the commit will be created but the builds will be skipped.
A
Achilleas Pipinellis 已提交
1091 1092 1093 1094 1095 1096 1097

## Examples

Visit the [examples README][examples] to see a list of examples using GitLab
CI with various languages.

[examples]: ../examples/README.md