Commit 19593b0b authored by Grzegorz Bizon's avatar Grzegorz Bizon

Update docs on setting up a CI/CD coverage regexp

parent 7c271fb5
...@@ -76,7 +76,6 @@ There are a few reserved `keywords` that **cannot** be used as job names: ...@@ -76,7 +76,6 @@ There are a few reserved `keywords` that **cannot** be used as job names:
| after_script | no | Define commands that run after each job's script | | after_script | no | Define commands that run after each job's script |
| variables | no | Define build variables | | variables | no | Define build variables |
| cache | no | Define list of files that should be cached between subsequent runs | | cache | no | Define list of files that should be cached between subsequent runs |
| coverage | no | Define coverage settings for all jobs |
### image and services ### image and services
...@@ -279,23 +278,6 @@ cache: ...@@ -279,23 +278,6 @@ cache:
untracked: true untracked: true
``` ```
### coverage
`coverage` allows you to configure how coverage will be filtered out from the
build outputs. Setting this up globally will make all the jobs to use this
setting for output filtering and extracting the coverage information from your
builds.
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:
```yaml
coverage: /\(\d+\.\d+\) covered\./
```
## Jobs ## Jobs
`.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job `.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job
...@@ -337,7 +319,7 @@ job_name: ...@@ -337,7 +319,7 @@ job_name:
| before_script | no | Override a set of commands that are executed before build | | 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 | | after_script | no | Override a set of commands that are executed after build |
| environment | no | Defines a name of environment to which deployment is done by this build | | environment | no | Defines a name of environment to which deployment is done by this build |
| coverage | no | Define coverage settings for a given job | | coverage | no | Define code coverage settings for a given job |
### script ### script
...@@ -1012,25 +994,23 @@ job: ...@@ -1012,25 +994,23 @@ job:
- execute this after my script - execute this after my script
``` ```
### job coverage ### coverage
This entry is pretty much the same as described in the global context in `coverage` allows you to configure how coverage will be filtered out from the
[`coverage`](#coverage). The only difference is that, by setting it inside build outputs. Setting this in the job context will define how the output
the job level, whatever is set in there will take precedence over what has filtering and extracting the coverage information from your builds will work.
been defined in the global level. A quick example of one overriding the
other would be: 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:
```yaml ```yaml
coverage: /\(\d+\.\d+\) covered\./ coverage: /\(\d+\.\d+\) covered\./
job1:
coverage: /Code coverage: \d+\.\d+/
``` ```
In the example above, considering the context of the job `job1`, the coverage
regex that would be used is `/Code coverage: \d+\.\d+/` instead of
`/\(\d+\.\d+\) covered\./`.
## Git Strategy ## Git Strategy
> Introduced in GitLab 8.9 as an experimental feature. May change or be removed > Introduced in GitLab 8.9 as an experimental feature. May change or be removed
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment