BigW Consortium Gitlab

README.md 38.4 KB
Newer Older
1
# Configuration of your jobs with .gitlab-ci.yml
2

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

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:
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.
32

33 34 35
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.
36

37 38
The YAML syntax allows for using more complex job specifications than in the
above example:
39 40

```yaml
James Lopez committed
41
image: ruby:2.1
42 43 44 45
services:
  - postgres

before_script:
frodsan committed
46
  - bundle install
47

48 49 50
after_script:
  - rm secrets

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
stages:
  - build
  - test
  - deploy

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

66
There are a few reserved `keywords` that **cannot** be used as job names:
67

68
| Keyword       | Required | Description |
69
|---------------|----------|-------------|
70 71 72
| 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 |
73
| types         | no | Alias for `stages` (deprecated) |
74
| before_script | no | Define commands that run before each job's script |
75
| after_script  | no | Define commands that run after each job's script |
76 77
| variables     | no | Define build variables |
| cache         | no | Define list of files that should be cached between subsequent runs |
78 79

### image and services
80 81

This allows to specify a custom Docker image and a list of services that can be
82
used for time of the job. The configuration of this feature is covered in
83
[a separate document](../docker/README.md).
84 85

### before_script
86 87

`before_script` is used to define the command that should be run before all
88 89
jobs, including deploy jobs, but after the restoration of artifacts. This can
be an array or a multi-line string.
90

91 92
### after_script

93
> Introduced in GitLab 8.7 and requires Gitlab Runner v1.2
94

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

98
### stages
99

100
`stages` is used to define stages that can be used by jobs.
101 102
The specification of `stages` allows for having flexible multi stage pipelines.

103
The ordering of elements in `stages` defines the ordering of jobs' execution:
104

105 106
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
107
   complete successfully.
108 109

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

```yaml
112 113 114 115 116 117
stages:
  - build
  - test
  - deploy
```

118
1. First, all jobs of `build` are executed in parallel.
119 120 121
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`.
122 123
1. If any of the previous jobs fails, the commit is marked as `failed` and no
   jobs of further stage are executed.
124 125 126

There are also two edge cases worth mentioning:

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

### types
132

133 134
> Deprecated, and will be removed in 10.0. Use [stages](#stages) instead.

135 136 137 138
Alias for [stages](#stages).

### variables

139
> Introduced in GitLab Runner v0.5.0.
140

Mark Pundsack committed
141
GitLab CI allows you to add variables to `.gitlab-ci.yml` that are set in the
142
job environment. The variables are stored in the Git repository and are meant
Mark Pundsack committed
143
to store non-sensitive project configuration, for example:
144 145 146 147 148 149

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

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

154
These variables can be later used in all executed commands and scripts.
155
The YAML-defined variables are also set to all created service containers,
156 157
thus allowing to fine tune them. Variables can be also defined on a
[job level](#job-variables).
158

159
Except for the user defined variables, there are also the ones set up by the
160
Runner itself. One example would be `CI_COMMIT_REF_NAME` which has the value of
161 162 163
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 secret variables
which can be set in GitLab's UI.
164

165
[Learn more about variables.][variables]
166

167 168
### cache

169 170 171 172 173
>
**Notes:**
- Introduced in GitLab Runner v0.7.0.
- Prior to GitLab 9.2, caches were restored after artifacts.
- From GitLab 9.2, caches are restored before artifacts.
174

175
`cache` is used to specify a list of files and directories which should be
176
cached between jobs. You can only use paths that are within the project
177
workspace.
178

179 180
**By default caching is enabled and shared between pipelines and jobs,
starting from GitLab 9.0**
181

182 183
If `cache` is defined outside the scope of jobs, it means it is set
globally and all jobs will use that definition.
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 210 211 212 213 214 215
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/
```

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

```yaml
220 221
cache:
  paths:
222 223 224 225 226
  - my/files

rspec:
  script: test
  cache:
227
    key: rspec
228 229
    paths:
    - binaries/
230 231
```

232
Note that since cache is shared between jobs, if you're using different
233
paths for different jobs, you should also set a different **cache:key**
234
otherwise cache content can be overwritten.
235

Mark Pundsack committed
236 237
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.
238

239 240
#### cache:key

241
> Introduced in GitLab Runner v1.0.0.
242 243 244 245 246

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.

247 248
This allows you to fine tune caching, allowing you to cache data between
different jobs or even different branches.
249

250 251
The `cache:key` variable can use any of the [predefined variables](../variables/README.md).

252 253 254
The default key is **default** across the project, therefore everything is
shared between each pipelines and jobs by default, starting from GitLab 9.0.

255 256 257
---

**Example configurations**
258 259 260

To enable per-job caching:

261 262
```yaml
cache:
263
  key: "$CI_JOB_NAME"
264 265
  untracked: true
```
266 267 268

To enable per-branch caching:

269 270
```yaml
cache:
271
  key: "$CI_COMMIT_REF_NAME"
272 273
  untracked: true
```
274 275 276

To enable per-job and per-branch caching:

277 278
```yaml
cache:
279
  key: "$CI_JOB_NAME/$CI_COMMIT_REF_NAME"
280 281
  untracked: true
```
282 283 284

To enable per-branch and per-stage caching:

285 286
```yaml
cache:
287
  key: "$CI_JOB_STAGE/$CI_COMMIT_REF_NAME"
288 289
  untracked: true
```
290

291 292
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:
293

294 295
```yaml
cache:
296
  key: "%CI_JOB_STAGE%/%CI_COMMIT_REF_NAME%"
297 298
  untracked: true
```
299

300
## Jobs
301 302

`.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job
303 304
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 job behavior.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

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

322
| Keyword       | Required | Description |
323
|---------------|----------|-------------|
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
| script        | yes      | Defines a shell script which is executed by Runner |
| 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) |
| stage         | no       | Defines a job stage (default: `test`) |
| type          | no       | Alias for `stage` |
| variables     | no       | Define job variables on a job level |
| only          | no       | Defines a list of git refs for which job is created |
| except        | no       | Defines a list of git refs for which job is not created |
| tags          | no       | Defines a list of tags which are used to select Runner |
| allow_failure | no       | Allow job to fail. Failed job doesn't contribute to commit status |
| when          | no       | Define when to run job. Can be `on_success`, `on_failure`, `always` or `manual` |
| dependencies  | no       | Define other jobs that a job depends on so that you can pass artifacts between them|
| artifacts     | no       | Define list of [job artifacts](../../user/project/pipelines/job_artifacts.md) |
| cache         | no       | Define list of files that should be cached between subsequent runs |
| before_script | no       | Override a set of commands that are executed before job |
| after_script  | no       | Override a set of commands that are executed after job |
| environment   | no       | Defines a name of environment to which deployment is done by this job |
| coverage      | no       | Define code coverage settings for a given job |
342 343

### script
344

345
`script` is a shell script which is executed by the Runner. For example:
346 347 348 349 350 351 352

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

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

354 355 356 357 358 359 360
```yaml
job:
  script:
    - uname -a
    - bundle exec rspec
```

361 362 363 364 365
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:
`:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``.
366

367
### stage
368

369
`stage` allows to group jobs into different stages. Jobs of the same `stage`
370 371
are executed in `parallel`. For more info about the use of `stage` please check
[stages](#stages).
372 373 374

### only and except

375 376
`only` and `except` are two parameters that set a refs policy to limit when
jobs are built:
377

378
1. `only` defines the names of branches and tags for which the job will run.
379
2. `except` defines the names of branches and tags for which the job will
380
    **not** run.
381 382 383 384 385 386

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.
387
* `only` and `except` allow the use of special keywords: `branches`, `tags`, and `triggers`.
388 389 390 391 392
* `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.
393 394 395

```yaml
job:
396
  # use regexp
397
  only:
398 399
    - /^issue-.*$/
  # use special keyword
400
  except:
401
    - branches
402 403
```

404 405
In this example, `job` will run only for refs that are tagged, or if a build is
explicitly requested via an API trigger.
406 407 408 409 410 411 412 413 414

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

415 416
The repository path can be used to have jobs executed only for the parent
repository and not forks:
417 418 419 420 421 422 423 424

```yaml
job:
  only:
    - branches@gitlab-org/gitlab-ce
  except:
    - master@gitlab-org/gitlab-ce
```
425 426 427

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

429
### Job variables
430

431 432 433
It is possible to define job variables using a `variables` keyword on a job
level. It works basically the same way as its [global-level equivalent](#variables),
but allows you to define job-specific variables.
434

435 436
When the `variables` keyword is used on a job level, it overrides the global YAML
job variables and predefined ones. To turn off global defined variables
437
in your job, define an empty array:
438

439 440 441 442 443
```yaml
job_name:
  variables: []
```

444
Job variables priority is defined in the [variables documentation][variables].
445

446 447
### tags

448
`tags` is used to select specific Runners from the list of all Runners that are
449
allowed to run this project.
450

451
During the registration of a Runner, you can specify the Runner's tags, for
452 453
example `ruby`, `postgres`, `development`.

454
`tags` allow you to run jobs with Runners that have the specified tags
455 456 457
assigned to them:

```yaml
458 459 460 461 462 463
job:
  tags:
    - ruby
    - postgres
```

464
The specification above, will make sure that `job` is built by a Runner that
465
has both `ruby` AND `postgres` tags defined.
466

467 468
### allow_failure

469 470
`allow_failure` is used when you want to allow a job to fail without impacting
the rest of the CI suite. Failed jobs don't contribute to the commit status.
471

472
When enabled and the job fails, the pipeline will be successful/green for all
473
intents and purposes, but a "CI build passed with warnings" message  will be
474 475
displayed on the merge request or commit or job page. This is to be used by
jobs that are allowed to fail, but where failure indicates some other (manual)
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
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
```

500
### when
501 502 503

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

Robert Speicher committed
505 506
`when` can be set to one of the following values:

507
1. `on_success` - execute job only when all jobs from prior stages
508
    succeed. This is the default.
509
1. `on_failure` - execute job only when at least one job from prior stages
510
    fails.
511 512
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
513
    [manual actions](#manual-actions) below.
514

515 516 517
For example:

```yaml
518 519 520 521 522 523 524
stages:
- build
- cleanup_build
- test
- deploy
- cleanup

525
build_job:
526 527 528 529
  stage: build
  script:
  - make build

530
cleanup_build_job:
531 532 533 534 535
  stage: cleanup_build
  script:
  - cleanup build when failed
  when: on_failure

536
test_job:
537 538 539 540
  stage: test
  script:
  - make test

541
deploy_job:
542 543 544
  stage: deploy
  script:
  - make deploy
545
  when: manual
546

547
cleanup_job:
548 549
  stage: cleanup
  script:
550
  - cleanup after jobs
551 552 553 554
  when: always
```

The above script will:
555

556 557 558 559
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.
560 561 562

#### Manual actions

563
> Introduced in GitLab 8.10.
564 565
> Blocking manual actions were introduced in GitLab 9.0
> Protected actions were introduced in GitLab 9.2
566

567 568
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
569
from pipeline, build, environment, and deployment views.
570

571
An example usage of manual actions is deployment to production.
572

573 574
Read more at the [environments documentation][env-manual].

575 576 577 578 579 580 581 582 583 584 585 586
Manual actions can be either optional or blocking. Blocking manual action will
block execution of the pipeline at stage this action is defined in. It is
possible to resume execution of the pipeline when someone executes a blocking
manual actions by clicking a _play_ button.

When pipeline is blocked it will not be merged if Merge When Pipeline Succeeds
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`.

587 588 589 590
Optional manual actions have `allow_failure: true` set by default.

**Statuses of optional actions do not contribute to overall pipeline status.**

591 592 593 594
**Manual actions are considered to be write actions, so permissions for
protected branches are used when 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, user needs to have ability to push to this branch.**
595

596 597
### environment

598 599 600 601 602
>
**Notes:**
- Introduced in GitLab 8.9.
- You can read more about environments and find more examples in the
  [documentation about environments][environment].
603

604
`environment` is used to define that a job deploys to a specific environment.
Mark Pundsack committed
605 606
If `environment` is specified and no environment under that name exists, a new
one will be created automatically.
607

608
In its simplest form, the `environment` keyword can be defined like:
609

610
```yaml
611 612 613
deploy to production:
  stage: deploy
  script: git push production HEAD:master
614 615
  environment:
    name: production
616 617
```

618 619 620 621 622
In the above example, the `deploy to production` job will be marked as doing a
deployment to the `production` environment.

#### environment:name

623 624 625 626 627 628
>
**Notes:**
- 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.
629

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
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.

645 646 647 648
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`:

649
```yaml
650 651 652 653 654 655 656 657 658
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment:
    name: production
```

#### environment:url

659 660 661 662 663
>
**Notes:**
- 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`.
664 665 666 667 668 669 670 671

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`.

672
```yaml
673 674 675 676 677 678 679 680 681 682
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment:
    name: production
    url: https://prod.example.com
```

#### environment:on_stop

683 684 685 686 687 688
>
**Notes:**
- [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.
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733

Closing (stoping) environments can be achieved with the `on_stop` keyword defined under
`environment`. It declares a different job that runs in order to close
the environment.

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

#### environment:action

> [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.

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
set it up to `manual` so it will need a [manual action](#manual-actions) via
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`
734 735
- `stage` should be the same as the `review_app` in order for the environment
  to stop automatically when the branch is deleted
736

737 738
#### dynamic environments

739 740 741 742
>
**Notes:**
- [Introduced][ce-6323] in GitLab 8.12 and GitLab Runner 1.6.
- The `$CI_ENVIRONMENT_SLUG` was [introduced][ce-7983] in GitLab 8.15.
743 744

`environment` can also represent a configuration hash with `name` and `url`.
745
These parameters can use any of the defined [CI variables](#variables)
746
(including predefined, secure variables and `.gitlab-ci.yml` variables).
747

748
For example:
749

750
```yaml
751 752
deploy as review app:
  stage: deploy
753
  script: make deploy
754
  environment:
755
    name: review/$CI_COMMIT_REF_NAME
756
    url: https://$CI_ENVIRONMENT_SLUG.example.com/
757 758
```

759
The `deploy as review app` job will be marked as deployment to dynamically
760
create the `review/$CI_COMMIT_REF_NAME` environment, where `$CI_COMMIT_REF_NAME`
761 762 763 764
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
765
`https://review-pow.example.com/`.
766

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

770 771
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
772
<https://gitlab.com/gitlab-examples/review-apps-nginx/>.
773

774 775
### artifacts

776
>
777 778 779
**Notes:**
- Introduced in GitLab Runner v0.7.0 for non-Windows platforms.
- Windows support was added in GitLab Runner v.1.0.0.
780 781
- Prior to GitLab 9.2, caches were restored after artifacts.
- From GitLab 9.2, caches are restored before artifacts.
782 783
- Currently not all executors are supported.
- Job artifacts are only collected for successful jobs by default.
784

785
`artifacts` is used to specify a list of files and directories which should be
786 787
attached to the job after success. You can only use paths that are within the
project workspace. To pass artifacts between different jobs, see [dependencies](#dependencies).
788
Below are some examples.
789

790
Send all files in `binaries` and `.config`:
791

792 793 794 795 796 797
```yaml
artifacts:
  paths:
  - binaries/
  - .config
```
798

799
Send all Git untracked files:
800

801 802 803 804 805
```yaml
artifacts:
  untracked: true
```

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

808 809 810 811 812 813
```yaml
artifacts:
  untracked: true
  paths:
  - binaries/
```
814

815 816 817 818 819 820 821 822 823
To disable artifact passing, define the job with empty [dependencies](#dependencies):

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

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
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
```

846
The artifacts will be sent to GitLab after the job finishes successfully and will
847
be available for download in the GitLab UI.
848

849 850
#### artifacts:name

851
> Introduced in GitLab 8.6 and GitLab Runner v1.1.0.
852

853
The `name` directive allows you to define the name of the created artifacts
854
archive. That way, you can have a unique name for every archive which could be
855 856
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).
857
The default name is `artifacts`, which becomes `artifacts.zip` when downloaded.
858 859 860 861 862

---

**Example configurations**

863
To create an archive with a name of the current job:
864 865 866 867

```yaml
job:
  artifacts:
868
    name: "$CI_JOB_NAME"
869 870
```

871 872
To create an archive with a name of the current branch or tag including only
the files that are untracked by Git:
873 874 875 876

```yaml
job:
   artifacts:
877
     name: "$CI_COMMIT_REF_NAME"
878 879 880
     untracked: true
```

881
To create an archive with a name of the current job and the current branch or
882
tag including only the files that are untracked by Git:
883 884 885 886

```yaml
job:
  artifacts:
887
    name: "${CI_JOB_NAME}_${CI_COMMIT_REF_NAME}"
888 889 890
    untracked: true
```

891
To create an archive with a name of the current [stage](#stages) and branch name:
892 893 894 895

```yaml
job:
  artifacts:
896
    name: "${CI_JOB_STAGE}_${CI_COMMIT_REF_NAME}"
897 898 899
    untracked: true
```

900 901
---

902 903 904 905 906 907
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:

```yaml
job:
  artifacts:
908
    name: "%CI_JOB_STAGE%_%CI_COMMIT_REF_NAME%"
909 910 911
    untracked: true
```

912 913
#### artifacts:when

914
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
915

916
`artifacts:when` is used to upload artifacts on job failure or despite the
917 918 919 920
failure.

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

921 922 923
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.
924 925 926 927 928

---

**Example configurations**

929
To upload artifacts only when job fails.
930 931 932 933 934 935 936

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

937 938
#### artifacts:expire_in

939
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
940

941 942 943 944
`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.
945

946
You can use the **Keep** button on the job page to override expiration and
947
keep artifacts forever.
948

949 950
After expiry, artifacts are actually deleted hourly by default (via a cron job),
but they are not accessible after expiry.
951

952
The value of `expire_in` is an elapsed time. Examples of parseable values:
953

954 955 956 957 958 959 960 961 962 963 964
- '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**

965
To expire artifacts 1 week after being uploaded:
966 967 968 969 970 971 972

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

973 974
### dependencies

975
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
976

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

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

982
To use this feature, define `dependencies` in context of the job and pass
983 984 985
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.
An error will be shown if you define jobs from the current stage or next ones.
986
Defining an empty array will skip downloading any artifacts for that job.
987 988

---
989

990 991 992 993 994
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`.

995
The job `deploy` will download artifacts from all previous jobs because of
996
the [stage](#stages) precedence:
997

998
```yaml
999 1000
build:osx:
  stage: build
1001
  script: make build:osx
1002 1003 1004
  artifacts:
    paths:
    - binaries/
1005

1006 1007
build:linux:
  stage: build
1008
  script: make build:linux
1009 1010 1011 1012 1013 1014
  artifacts:
    paths:
    - binaries/

test:osx:
  stage: test
1015
  script: make test:osx
1016 1017 1018 1019 1020
  dependencies:
  - build:osx

test:linux:
  stage: test
1021
  script: make test:linux
1022 1023 1024 1025 1026
  dependencies:
  - build:linux

deploy:
  stage: deploy
1027
  script: make deploy
1028 1029
```

1030 1031
### before_script and after_script

1032
It's possible to overwrite the globally defined `before_script` and `after_script`:
1033 1034

```yaml
1035
before_script:
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
- global before script

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

1047
### coverage
1048

1049 1050 1051
**Notes:**
- [Introduced][ce-7447] in GitLab 8.17.

1052 1053
`coverage` allows you to configure how code coverage will be extracted from the
job output.
1054

1055 1056 1057 1058 1059 1060
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:
1061 1062 1063

```yaml
job1:
1064
  coverage: '/Code coverage: \d+\.\d+/'
1065 1066
```

1067 1068
## Git Strategy

1069 1070 1071 1072 1073 1074 1075 1076
> 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+.

You can set the `GIT_STRATEGY` used for getting recent application code, either
in the global [`variables`](#variables) section or the [`variables`](#job-variables)
section for individual jobs. If left unspecified, the default from project
settings will be used.
1077

1078 1079 1080 1081
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.
1082

1083
```yaml
1084 1085 1086 1087
variables:
  GIT_STRATEGY: clone
```

1088 1089 1090
`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.
1091

1092
```yaml
1093 1094 1095 1096
variables:
  GIT_STRATEGY: fetch
```

1097 1098 1099 1100 1101 1102
`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.

1103
```yaml
1104 1105 1106 1107
variables:
  GIT_STRATEGY: none
```

1108 1109 1110 1111 1112 1113 1114 1115 1116
## Git Submodule Strategy

> Requires GitLab Runner v1.10+.

The `GIT_SUBMODULE_STRATEGY` variable is used to control if / how Git
submodules are included when fetching the code before a build. Like
`GIT_STRATEGY`, it can be set in either the global [`variables`](#variables)
section or the [`variables`](#job-variables) section for individual jobs.

1117
There are three possible values: `none`, `normal`, and `recursive`:
1118 1119 1120 1121 1122 1123

- `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:
1124

1125
    ```
1126 1127
    git submodule sync
    git submodule update --init
1128 1129 1130 1131
    ```

- `recursive` means that all submodules (including submodules of submodules)
  will be included. It is equivalent to:
1132

1133
    ```
1134 1135
    git submodule sync --recursive
    git submodule update --init --recursive
1136 1137 1138 1139
    ```

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

1141 1142 1143 1144 1145
- 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.


1146
## Job stages attempts
1147 1148 1149

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

1150
You can set the number for attempts the running job will try to execute each
1151 1152
of the following stages:

1153 1154 1155 1156 1157
| 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 |
1158 1159 1160 1161 1162

The default is one single attempt.

Example:

1163
```yaml
1164
variables:
1165
  GET_SOURCES_ATTEMPTS: 3
1166 1167
```

1168 1169
You can set them in the global [`variables`](#variables) section or the
[`variables`](#job-variables) section for individual jobs.
1170

1171 1172
## Shallow cloning

1173
> Introduced in GitLab 8.9 as an experimental feature. May change in future
1174
releases or be removed completely.
1175 1176

You can specify the depth of fetching and cloning using `GIT_DEPTH`. This allows
1177 1178 1179
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`.
1180

1181
>**Note:**
1182 1183
If you use a depth of 1 and have a queue of jobs or retry
jobs, jobs may fail.
1184

1185 1186 1187 1188
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
1189
it impossible to run these old commits. You will see `unresolved reference` in
1190
job logs. You should then reconsider changing `GIT_DEPTH` to a higher value.
1191

1192 1193
Jobs that rely on `git describe` may not work correctly when `GIT_DEPTH` is
set since only part of the Git history is present.
1194 1195

To fetch or clone only the last 3 commits:
1196 1197

```yaml
1198
variables:
1199
  GIT_DEPTH: "3"
1200 1201
```

1202
## Hidden keys
Achilleas Pipinellis committed
1203

1204
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
Achilleas Pipinellis committed
1205

1206
Keys that start with a dot (`.`) will be not processed by GitLab CI. You can
Achilleas Pipinellis committed
1207
use this feature to ignore jobs, or use the
1208
[special YAML features](#special-yaml-features) and transform the hidden keys
Achilleas Pipinellis committed
1209 1210
into templates.

1211
In the following example, `.key_name` will be ignored:
Achilleas Pipinellis committed
1212 1213

```yaml
1214
.key_name:
Achilleas Pipinellis committed
1215 1216 1217 1218
  script:
    - rake spec
```

1219 1220 1221
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.

1222
## Special YAML features
1223

1224 1225 1226
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`.
1227

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

1230 1231
### Anchors

1232
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
1233

1234
YAML has a handy feature called 'anchors', which lets you easily duplicate
1235
content across your document. Anchors can be used to duplicate/inherit
1236
properties, and is a perfect example to be used with [hidden keys](#hidden-keys)
1237 1238 1239 1240 1241
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:
1242 1243

```yaml
1244
.job_template: &job_definition  # Hidden key that defines an anchor named 'job_definition'
1245 1246 1247 1248 1249 1250
  image: ruby:2.1
  services:
    - postgres
    - redis

test1:
1251
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
1252
  script:
1253
    - test1 project
1254 1255

test2:
1256
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
1257
  script:
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
    - 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
1287 1288
```

1289 1290 1291 1292
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:
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

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

.postgres_services:
  services: &postgres_definition
    - postgres
    - ruby

1304
.mysql_services:
1305 1306 1307 1308 1309
  services: &mysql_definition
    - mysql
    - ruby

test:postgres:
1310
  <<: *job_definition
1311 1312 1313
  services: *postgres_definition

test:mysql:
1314
  <<: *job_definition
1315 1316 1317
  services: *mysql_definition
```

1318
The expanded version looks like this:
1319

1320 1321 1322 1323
```yaml
.job_template:
  script:
    - test project
1324

1325 1326 1327 1328
.postgres_services:
  services:
    - postgres
    - ruby
1329

1330 1331 1332 1333 1334 1335
.mysql_services:
  services:
    - mysql
    - ruby

test:postgres:
1336
  script:
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
    - test project
  services:
    - postgres
    - ruby

test:mysql:
  script:
    - test project
  services:
    - mysql
    - ruby
1348 1349
```

1350
You can see that the hidden keys are conveniently used as templates.
1351

1352 1353 1354 1355 1356 1357 1358
## 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)

1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
### pages

`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:

1. Any static content must be placed under a `public/` directory
1. `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:

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

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

1388
## Validate the .gitlab-ci.yml
1389

1390
Each instance of GitLab CI has an embedded debug tool called Lint.
1391
You can find the link under `/ci/lint` of your gitlab instance.
1392

1393
## Skipping jobs
1394

1395
If your commit message contains `[ci skip]` or `[skip ci]`, using any
1396
capitalization, the commit will be created but the jobs will be skipped.
1397 1398 1399 1400 1401 1402

## Examples

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

1403
[env-manual]: ../environments.md#manually-deploying-to-environments
1404
[examples]: ../examples/README.md
1405 1406
[ce-6323]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6323
[environment]: ../environments.md
1407 1408
[ce-6669]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6669
[variables]: ../variables/README.md
1409
[ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983
1410
[ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447