README.md 36.2 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

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

91 92
### after_script

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

95 96 97
`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 已提交
98
### stages
99

D
Douwe Maan 已提交
100 101 102 103 104 105
`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.
106 107
1. Builds of the next stage are run after the jobs from the previous stage
   complete successfully.
D
Douwe Maan 已提交
108 109

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

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

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.
D
Douwe Maan 已提交
124 125 126

There are also two edge cases worth mentioning:

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

### types
132

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

### variables

137
> Introduced in GitLab Runner v0.5.0.
138

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

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

These variables can be later used in all executed commands and scripts.
149
The YAML-defined variables are also set to all created service containers,
150 151
thus allowing to fine tune them. Variables can be also defined on a
[job level](#job-variables).
D
Douwe Maan 已提交
152

153 154 155 156 157
Except for the user defined variables, there are also the ones set up by the
Runner itself. One example would be `CI_BUILD_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 secret variables
which can be set in GitLab's UI.
158

159
[Learn more about variables.][variables]
160

161 162
### cache

163
> Introduced in GitLab Runner v0.7.0.
164

165
`cache` is used to specify a list of files and directories which should be
166 167
cached between builds. You can only use paths that are within the project
workspace.
168 169

**By default the caching is enabled per-job and per-branch.**
170 171 172

If `cache` is defined outside the scope of the jobs, it means it is set
globally and all jobs will use its definition.
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
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/`:
207 208

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

rspec:
  script: test
  cache:
    paths:
    - binaries/
218 219
```

M
Mark Pundsack 已提交
220 221
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.
222

223 224
#### cache:key

225
> Introduced in GitLab Runner v1.0.0.
226 227 228 229 230

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.

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

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

---

**Example configurations**
239 240 241

To enable per-job caching:

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

To enable per-branch caching:

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

To enable per-job and per-branch caching:

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

To enable per-branch and per-stage caching:

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

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

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

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

`.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 已提交
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

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

303
| Keyword       | Required | Description |
D
Douwe Maan 已提交
304
|---------------|----------|-------------|
305
| script        | yes | Defines a shell script which is executed by Runner |
P
Pat Turner 已提交
306 307
| 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) |
308
| stage         | no | Defines a build stage (default: `test`) |
309
| type          | no | Alias for `stage` |
310
| variables     | no | Define build variables on a job level |
311 312
| 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 |
313
| tags          | no | Defines a list of tags which are used to select Runner |
314
| allow_failure | no | Allow build to fail. Failed build doesn't contribute to commit status |
315
| when          | no | Define when to run build. Can be `on_success`, `on_failure`, `always` or `manual` |
316
| dependencies  | no | Define other builds that a build depends on so that you can pass artifacts between them|
A
Aurelio Jargas 已提交
317
| artifacts     | no | Define list of build artifacts |
318
| cache         | no | Define list of files that should be cached between subsequent runs |
319 320
| 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 |
321
| environment   | no | Defines a name of environment to which deployment is done by this build |
322
| coverage      | no | Define code coverage settings for a given job |
D
Douwe Maan 已提交
323 324

### script
325

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

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

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

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

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

D
Douwe Maan 已提交
344
### stage
345 346 347 348

`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 已提交
349 350 351

### only and except

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

355 356 357 358 359 360 361 362 363 364
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.
365
* `only` and `except` allow the use of special keywords: `branches`, `tags`, and `triggers`.
366 367 368 369 370
* `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 已提交
371 372 373

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

382 383 384 385 386 387 388 389 390 391 392
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
```

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

```yaml
job:
  only:
    - branches@gitlab-org/gitlab-ce
  except:
    - master@gitlab-org/gitlab-ce
```
403 404 405

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

407 408 409
### job variables

It is possible to define build variables using a `variables` keyword on a job
A
Achilleas Pipinellis 已提交
410 411
level. It works basically the same way as its [global-level equivalent](#variables)
but allows you to define job-specific build variables.
412

413
When the `variables` keyword is used on a job level, it overrides global YAML
A
Achilleas Pipinellis 已提交
414 415
build variables and predefined variables. To turn off global defined variables
in your job, define an empty array:
416

A
Achilleas Pipinellis 已提交
417 418 419 420 421 422 423
```yaml
job_name:
  variables: []
```

Build variables priority is defined in the
[variables documentation][variables].
424

D
Douwe Maan 已提交
425 426
### tags

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

430
During the registration of a Runner, you can specify the Runner's tags, for
431 432
example `ruby`, `postgres`, `development`.

433
`tags` allow you to run builds with Runners that have the specified tags
434 435 436
assigned to them:

```yaml
D
Douwe Maan 已提交
437 438 439 440 441 442
job:
  tags:
    - ruby
    - postgres
```

443
The specification above, will make sure that `job` is built by a Runner that
444
has both `ruby` AND `postgres` tags defined.
D
Douwe Maan 已提交
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 471 472 473 474 475 476 477 478
### 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
```

479
### when
480 481 482

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

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

486
1. `on_success` - execute build only when all builds from prior stages
487
    succeed. This is the default.
488
1. `on_failure` - execute build only when at least one build from prior stages
489 490
    fails.
1. `always` - execute build regardless of the status of builds from prior stages.
491 492
1. `manual` - execute build manually (added in GitLab 8.10). Read about
    [manual actions](#manual-actions) below.
493

494 495 496
For example:

```yaml
497 498 499 500 501 502 503
stages:
- build
- cleanup_build
- test
- deploy
- cleanup

504
build_job:
505 506 507 508
  stage: build
  script:
  - make build

509
cleanup_build_job:
510 511 512 513 514
  stage: cleanup_build
  script:
  - cleanup build when failed
  when: on_failure

515
test_job:
516 517 518 519
  stage: test
  script:
  - make test

520
deploy_job:
521 522 523
  stage: deploy
  script:
  - make deploy
524
  when: manual
525

526
cleanup_job:
527 528 529 530 531 532 533
  stage: cleanup
  script:
  - cleanup after builds
  when: always
```

The above script will:
534

535 536 537 538
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.
539 540 541

#### Manual actions

542
> Introduced in GitLab 8.10.
543

544 545 546 547
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.
548

549
An example usage of manual actions is deployment to production.
550

551 552
Read more at the [environments documentation][env-manual].

553 554
### environment

555
> Introduced in GitLab 8.9.
556

557 558
> You can read more about environments and find more examples in the
[documentation about environments][environment].
559

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

564
In its simplest form, the `environment` keyword can be defined like:
565 566 567 568 569

```
deploy to production:
  stage: deploy
  script: git push production HEAD:master
570 571
  environment:
    name: production
572 573
```

574 575 576 577 578 579 580 581 582 583 584 585
In the above example, the `deploy to production` job will be marked as doing a
deployment to the `production` environment.

#### environment:name

> Introduced in GitLab 8.11.

>**Note:**
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.

586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
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.

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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`:

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

#### environment:url

> Introduced in GitLab 8.11.

>**Note:**
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`.

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

```
deploy to production:
  stage: deploy
  script: git push production HEAD:master
  environment:
    name: production
    url: https://prod.example.com
```

#### environment:on_stop

639 640 641 642 643 644
>
**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.
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689

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

691 692
#### dynamic environments

693
> [Introduced][ce-6323] in GitLab 8.12 and GitLab Runner 1.6.
694
  `$CI_ENVIRONMENT_SLUG` was [introduced][ce-7983] in GitLab 8.15
695 696

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

700
For example:
701 702 703 704

```
deploy as review app:
  stage: deploy
705
  script: make deploy
706
  environment:
707 708
    name: review/$CI_BUILD_REF_NAME
    url: https://$CI_ENVIRONMENT_SLUG.example.com/
709 710
```

711
The `deploy as review app` job will be marked as deployment to dynamically
712 713 714 715 716 717
create the `review/$CI_BUILD_REF_NAME` environment, where `$CI_BUILD_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-aaaaaa.example.com/`.
718

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

722 723 724
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/.
725

K
Kamil Trzcinski 已提交
726 727
### artifacts

728 729 730
>**Notes:**
>
> - Introduced in GitLab Runner v0.7.0 for non-Windows platforms.
731
> - Windows support was added in GitLab Runner v.1.0.0.
732
> - Currently not all executors are supported.
733
> - Build artifacts are only collected for successful builds by default.
734

735
`artifacts` is used to specify a list of files and directories which should be
736 737
attached to the build after success. You can only use paths that are within the
project workspace. To pass artifacts between different builds, see [dependencies](#dependencies).
738 739

Below are some examples.
740

741
Send all files in `binaries` and `.config`:
742

743 744 745 746 747 748
```yaml
artifacts:
  paths:
  - binaries/
  - .config
```
749

750
Send all Git untracked files:
751

752 753 754 755 756
```yaml
artifacts:
  untracked: true
```

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

759 760 761 762 763 764
```yaml
artifacts:
  untracked: true
  paths:
  - binaries/
```
K
Kamil Trzcinski 已提交
765

766 767 768 769 770 771 772 773 774
To disable artifact passing, define the job with empty [dependencies](#dependencies):

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

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
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
```

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

800 801
#### artifacts:name

802
> Introduced in GitLab 8.6 and GitLab Runner v1.1.0.
803

A
Achilleas Pipinellis 已提交
804
The `name` directive allows you to define the name of the created artifacts
805
archive. That way, you can have a unique name for every archive which could be
A
Achilleas Pipinellis 已提交
806 807
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).
808
The default name is `artifacts`, which becomes `artifacts.zip` when downloaded.
809 810 811 812 813

---

**Example configurations**

A
Achilleas Pipinellis 已提交
814
To create an archive with a name of the current build:
815 816 817 818 819 820 821

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

A
Achilleas Pipinellis 已提交
822 823
To create an archive with a name of the current branch or tag including only
the files that are untracked by Git:
824 825 826 827 828 829 830 831

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

A
Achilleas Pipinellis 已提交
832 833
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:
834 835 836 837 838 839 840 841

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

A
Achilleas Pipinellis 已提交
842
To create an archive with a name of the current [stage](#stages) and branch name:
843 844 845 846 847 848 849 850

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

A
Achilleas Pipinellis 已提交
851 852
---

853 854 855 856 857 858 859 860 861 862
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
```

863 864
#### artifacts:when

865
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
866 867 868 869 870 871

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

872 873 874
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.
875 876 877 878 879

---

**Example configurations**

K
Kamil Trzcinski 已提交
880
To upload artifacts only when build fails.
881 882 883 884 885 886 887

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

888 889
#### artifacts:expire_in

890
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
891

892 893 894 895
`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.
896

897 898
You can use the **Keep** button on the build page to override expiration and
keep artifacts forever.
899

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

903
The value of `expire_in` is an elapsed time. Examples of parseable values:
904 905 906 907 908 909 910 911 912 913 914
- '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**

915
To expire artifacts 1 week after being uploaded:
916 917 918 919 920 921 922

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

923 924
### dependencies

925
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
926

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

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

932
To use this feature, define `dependencies` in context of the job and pass
933
a list of all previous builds from which the artifacts should be downloaded.
934 935
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.
936
Defining an empty array will skip downloading any artifacts for that job.
937 938

---
939

940 941 942 943 944 945 946
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:
947

948
```yaml
949 950
build:osx:
  stage: build
951
  script: make build:osx
952 953 954
  artifacts:
    paths:
    - binaries/
955

956 957
build:linux:
  stage: build
958
  script: make build:linux
959 960 961 962 963 964
  artifacts:
    paths:
    - binaries/

test:osx:
  stage: test
965
  script: make test:osx
966 967 968 969 970
  dependencies:
  - build:osx

test:linux:
  stage: test
971
  script: make test:linux
972 973 974 975 976
  dependencies:
  - build:linux

deploy:
  stage: deploy
977
  script: make deploy
978 979
```

980 981 982 983 984
### before_script and after_script

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

```yaml
P
Philipp Kraus 已提交
985
before_script:
986 987 988 989 990 991 992 993 994 995 996
- global before script

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

997
### coverage
998

999 1000
`coverage` allows you to configure how code coverage will be extracted from the
job output.
1001

1002 1003 1004 1005 1006 1007
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:
1008 1009 1010

```yaml
job1:
1011
  coverage: /Code coverage: \d+\.\d+/
1012 1013
```

M
Mark Pundsack 已提交
1014 1015
## Git Strategy

N
Nick Thomas 已提交
1016 1017 1018 1019 1020 1021 1022 1023
> 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.
M
Mark Pundsack 已提交
1024

N
Nick Thomas 已提交
1025 1026 1027 1028
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 已提交
1029 1030 1031 1032 1033 1034

```
variables:
  GIT_STRATEGY: clone
```

N
Nick Thomas 已提交
1035 1036 1037
`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 已提交
1038 1039 1040 1041 1042 1043

```
variables:
  GIT_STRATEGY: fetch
```

N
Nick Thomas 已提交
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
`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.

```
variables:
  GIT_STRATEGY: none
```

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
## 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.

There are three posible values: `none`, `normal`, and `recursive`:

- `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:
    ```
    $ git submodule sync
    $ git submodule update --init
    ```

- `recursive` means that all submodules (including submodules of submodules)
  will be included. It is equivalent to:
    ```
    $ git submodule sync --recursive
    $ git submodule update --init --recursive
    ```

Note that for this feature to work correctly, the submodules must be configured
(in `.gitmodules`) with either:
- 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.


1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
## Build stages attempts

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

You can set the number for attempts the running build will try to execute each
of the following stages:

| Variable                | Description |
|-------------------------|-------------|
| **GET_SOURCES_ATTEMPTS** | Number of attempts to fetch sources running a build |
| **ARTIFACT_DOWNLOAD_ATTEMPTS** | Number of attempts to download artifacts running a build |
| **RESTORE_CACHE_ATTEMPTS** | Number of attempts to restore the cache running a build |

The default is one single attempt.

Example:

```
variables:
  GET_SOURCES_ATTEMPTS: "3"
```

J
James Lopez 已提交
1112
You can set them in the global [`variables`](#variables) section or the [`variables`](#job-variables)
1113 1114
section for individual jobs.

M
Mark Pundsack 已提交
1115 1116
## Shallow cloning

1117
> Introduced in GitLab 8.9 as an experimental feature. May change in future
M
Mark Pundsack 已提交
1118
releases or be removed completely.
M
Mark Pundsack 已提交
1119 1120

You can specify the depth of fetching and cloning using `GIT_DEPTH`. This allows
M
Mark Pundsack 已提交
1121 1122 1123
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 已提交
1124

M
Mark Pundsack 已提交
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
>**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 已提交
1140 1141
```
variables:
M
Mark Pundsack 已提交
1142
  GIT_DEPTH: "3"
M
Mark Pundsack 已提交
1143 1144
```

1145
## Hidden keys
A
Achilleas Pipinellis 已提交
1146

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

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

1154
In the following example, `.key_name` will be ignored:
A
Achilleas Pipinellis 已提交
1155 1156

```yaml
1157
.key_name:
A
Achilleas Pipinellis 已提交
1158 1159 1160 1161
  script:
    - rake spec
```

1162 1163 1164
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.

1165
## Special YAML features
1166

1167 1168 1169
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`.
1170

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

1173 1174
### Anchors

1175
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
1176 1177 1178

YAML also has a handy feature called 'anchors', which let you easily duplicate
content across your document. Anchors can be used to duplicate/inherit
1179
properties, and is a perfect example to be used with [hidden keys](#hidden-keys)
1180 1181 1182 1183 1184
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:
1185 1186

```yaml
1187
.job_template: &job_definition  # Hidden key that defines an anchor named 'job_definition'
1188 1189 1190 1191 1192 1193
  image: ruby:2.1
  services:
    - postgres
    - redis

test1:
1194
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
1195
  script:
1196
    - test1 project
1197 1198

test2:
1199
  <<: *job_definition           # Merge the contents of the 'job_definition' alias
1200
  script:
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
    - 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
1230 1231
```

1232 1233 1234 1235
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:
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

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

.postgres_services:
  services: &postgres_definition
    - postgres
    - ruby

1247
.mysql_services:
1248 1249 1250 1251 1252
  services: &mysql_definition
    - mysql
    - ruby

test:postgres:
A
Achilleas Pipinellis 已提交
1253
  <<: *job_definition
1254 1255 1256
  services: *postgres_definition

test:mysql:
A
Achilleas Pipinellis 已提交
1257
  <<: *job_definition
1258 1259 1260
  services: *mysql_definition
```

1261
The expanded version looks like this:
1262

1263 1264 1265 1266
```yaml
.job_template:
  script:
    - test project
1267

1268 1269 1270 1271
.postgres_services:
  services:
    - postgres
    - ruby
1272

1273 1274 1275 1276 1277 1278
.mysql_services:
  services:
    - mysql
    - ruby

test:postgres:
1279
  script:
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
    - test project
  services:
    - postgres
    - ruby

test:mysql:
  script:
    - test project
  services:
    - mysql
    - ruby
1291 1292
```

1293
You can see that the hidden keys are conveniently used as templates.
1294

1295 1296 1297 1298 1299 1300 1301
## 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)

1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
### 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
```

Read more on [GitLab Pages user documentation](../../pages/README.md).

D
Douwe Maan 已提交
1331
## Validate the .gitlab-ci.yml
1332

D
Douwe Maan 已提交
1333
Each instance of GitLab CI has an embedded debug tool called Lint.
1334
You can find the link under `/ci/lint` of your gitlab instance.
D
Douwe Maan 已提交
1335 1336

## Skipping builds
1337

S
Simon Welsh 已提交
1338 1339
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 已提交
1340 1341 1342 1343 1344 1345

## Examples

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

1346
[env-manual]: ../environments.md#manually-deploying-to-environments
A
Achilleas Pipinellis 已提交
1347
[examples]: ../examples/README.md
1348 1349
[ce-6323]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6323
[environment]: ../environments.md
1350 1351
[ce-6669]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6669
[variables]: ../variables/README.md
1352
[ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983