settings.md 7.32 KB
Newer Older
1
# Pipelines settings
2

3
To reach the pipelines settings navigate to your project's
4
**Settings > CI/CD**.
5

6
The following settings can be configured per project.
7

8 9 10 11 12
## Git strategy

With Git strategy, you can choose the default way your repository is fetched
from GitLab in a job.

13
There are two options. Using:
14

15
- `git clone`, which is slower since it clones the repository from scratch
16
  for every job, ensuring that the project workspace is always pristine.
17
- `git fetch`, which is faster as it re-uses the project workspace (falling
18 19
  back to clone if it doesn't exist).

20
The default Git strategy can be overridden by the [GIT_STRATEGY variable](../../../ci/yaml/README.md#git-strategy)
21
in `.gitlab-ci.yml`.
22

23 24 25 26
## Git shallow clone

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

27 28
NOTE: **Note**:
As of GitLab 12.0, newly created projects will automatically have a default 
29 30 31 32 33 34 35 36 37 38 39
`git depth` value of `50`.

It is possible to limit the number of changes that GitLab CI/CD will fetch when cloning 
a repository. Setting a limit to `git depth` can speed up Pipelines execution. Maximum
allowed value is `1000`.

To disable shallow clone and make GitLab CI/CD fetch all branches and tags each time,
keep the value empty or set to `0`.

This value can also be [overridden by `GIT_DEPTH`](../../../ci/large_repositories/index.md#shallow-cloning) variable in `.gitlab-ci.yml` file.

40 41
## Timeout

42
Timeout defines the maximum amount of time in minutes that a job is able run.
Takuya Noguchi's avatar
Takuya Noguchi committed
43
This is configurable under your project's **Settings > CI/CD > General pipelines settings**.
44 45 46
The default value is 60 minutes. Decrease the time limit if you want to impose
a hard limit on your jobs' running time or increase it otherwise. In any case,
if the job surpasses the threshold, it is marked as failed.
47

Tomasz Maczukin's avatar
Tomasz Maczukin committed
48 49
### Timeout overriding on Runner level

50
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17221) in GitLab 10.7.
Tomasz Maczukin's avatar
Tomasz Maczukin committed
51 52

Project defined timeout (either specific timeout set by user or the default
53
60 minutes timeout) may be [overridden on Runner level](../../../ci/runners/README.html#setting-maximum-job-timeout-for-a-runner).
Tomasz Maczukin's avatar
Tomasz Maczukin committed
54

55
## Custom CI config path
56

57
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12509) in GitLab 9.4.
58

Lin Jen-Shin's avatar
Lin Jen-Shin committed
59 60
By default we look for the `.gitlab-ci.yml` file in the project's root
directory. If you require a different location **within** the repository,
61
you can set a custom filepath that will be used to lookup the config file,
62 63 64 65
this filepath should be **relative** to the root.

Here are some valid examples:

66 67 68 69
- `.gitlab-ci.yml`
- `.my-custom-file.yml`
- `my/path/.gitlab-ci.yml`
- `my/path/.my-custom-file.yml`
70

71 72 73
## Test coverage parsing

If you use test coverage in your code, GitLab can capture its output in the
74
job log using a regular expression. In the pipelines settings, search for the
75
"Test coverage parsing" section.
76

77 78 79
![Pipelines settings test coverage](img/pipelines_settings_test_coverage.png)

Leave blank if you want to disable it or enter a ruby regular expression. You
80
can use <http://rubular.com> to test your regex.
81 82

If the pipeline succeeds, the coverage is shown in the merge request widget and
83
in the jobs table.
84 85 86 87 88 89 90

![MR widget coverage](img/pipelines_test_coverage_mr_widget.png)

![Build status coverage](img/pipelines_test_coverage_build.png)

A few examples of known coverage tools for a variety of languages can be found
in the pipelines settings page.
91 92 93

## Visibility of pipelines

94 95
Access to pipelines and job details (including output of logs and artifacts)
is checked against your current user access level and the **Public pipelines**
96
project setting under your project's **Settings > CI/CD > General pipelines settings**.
97 98 99

If **Public pipelines** is enabled (default):

100 101 102
- For **public** projects, anyone can view the pipelines and access the job details
  (output logs and artifacts).
- For **internal** projects, any logged in user can view the pipelines
103
  and access the job details
104 105
  (output logs and artifacts).
- For **private** projects, any member (guest or higher) can view the pipelines
106
  and access the job details
107
  (output logs and artifacts).
108 109 110

If **Public pipelines** is disabled:

111 112 113 114 115 116 117
- For **public** projects, anyone can view the pipelines, but only members
  (reporter or higher) can access the job details (output logs and artifacts).
- For **internal** projects, any logged in user can view the pipelines.
  However, only members (reporter or higher) can access the job details (output logs
  and artifacts).
- For **private** projects, only members (reporter or higher)
  can view the pipelines and access the job details (output logs and artifacts).
118

119 120
## Auto-cancel pending pipelines

121
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9362) in GitLab 9.1.
122

123 124
If you want to auto-cancel all pending non-HEAD pipelines on branch, when
new pipeline will be created (after your git push or manually from UI),
125 126
check **Auto-cancel pending pipelines** checkbox and save the changes.

127
## Pipeline Badges
128

129
In the pipelines settings page you can find pipeline status and test coverage
130
badges for your project. The latest successful pipeline will be used to read
131
the pipeline status and test coverage values.
132

133
Visit the pipelines settings page in your project to see the exact link to
134 135 136 137 138
your badges, as well as ways to embed the badge image in your HTML or Markdown
pages.

![Pipelines badges](img/pipelines_settings_badges.png)

139
### Pipeline status badge
140

141
Depending on the status of your job, a badge can have the following values:
142

143
- pending
144
- running
145
- passed
146 147
- failed
- skipped
148
- canceled
149 150
- unknown

151
You can access a pipeline status badge image using the following link:
152

153
```text
154
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/pipeline.svg
155
```
156

157
### Test coverage report badge
158

159
GitLab makes it possible to define the regular expression for [coverage report](#test-coverage-parsing),
160
that each job log will be matched against. This means that each job in the
161
pipeline can have the test coverage percentage value defined.
162

163
The test coverage badge can be accessed using following link:
164

165
```text
166 167
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg
```
168

169 170 171 172
If you would like to get the coverage report from a specific job, you can add
the `job=coverage_job_name` parameter to the URL. For example, the following
Markdown code will embed the test coverage report badge of the `coverage` job
into your `README.md`:
173

174 175 176
```markdown
![coverage](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage)
```
177

178 179 180 181 182 183
### Badge styles

Pipeline badges can be rendered in different styles by adding the `style=style_name` parameter to the URL. Currently two styles are available:

#### Flat (default)

184
```text
185 186 187 188 189 190 191
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat
```

![Badge flat style](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage&style=flat)

#### Flat square

192 193 194
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/30120) in GitLab 11.8.

```text
195 196 197 198 199 200
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square
```

![Badge flat square style](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage&style=flat-square)

## Environment Variables
201

202
[Environment variables](../../../ci/variables/README.html#gitlab-cicd-environment-variables) can be set in an environment to be available to a runner.