diff options
author | Douwe Maan <douwe@gitlab.com> | 2017-02-06 18:32:33 +0000 |
---|---|---|
committer | Douwe Maan <douwe@gitlab.com> | 2017-02-06 18:32:33 +0000 |
commit | 9b135435423cd475af0afc48a77c57bb85d393a0 (patch) | |
tree | 5305dfff5050ecea32e61b07610f0b5c3c5808cb /doc/ci | |
parent | c07311d486fd177bff6df8b2f912dc91dcadac4e (diff) | |
parent | a5cf7c2ef9d906b91372d93dbb6077db718dc89e (diff) | |
download | gitlab-ce-9b135435423cd475af0afc48a77c57bb85d393a0.tar.gz |
Merge branch 'fix/gb/backwards-compatibility-coverage-ci-yml' into 'master'
Remove coverage entry from global CI/CD options
See merge request !8981
Diffstat (limited to 'doc/ci')
-rw-r--r-- | doc/ci/yaml/README.md | 42 |
1 files changed, 11 insertions, 31 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 7b9cce32867..cd492d16747 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -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 | | variables | no | Define build variables | | cache | no | Define list of files that should be cached between subsequent runs | -| coverage | no | Define coverage settings for all jobs | ### image and services @@ -279,23 +278,6 @@ cache: 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 `.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job @@ -337,7 +319,7 @@ job_name: | 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 | | 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 @@ -1012,25 +994,23 @@ job: - execute this after my script ``` -### job coverage +### coverage -This entry is pretty much the same as described in the global context in -[`coverage`](#coverage). The only difference is that, by setting it inside -the job level, whatever is set in there will take precedence over what has -been defined in the global level. A quick example of one overriding the -other would be: +`coverage` allows you to configure how code coverage will be extracted from the +job output. -```yaml -coverage: /\(\d+\.\d+\) covered\./ +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 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 > Introduced in GitLab 8.9 as an experimental feature. May change or be removed |