diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2018-09-14 18:13:16 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-09-14 18:13:16 +0300 |
| commit | 1d76e5311fe04b5e1d0fce707e440cc2777632ed (patch) | |
| tree | 57a3d5706b7944805908b0d73ce9d1dd87e221fe /doc | |
| parent | 068a0a18486d831ff5d1fbd62045665fb2053132 (diff) | |
Copyedit extends CI yaml docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ci/yaml/README.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index aca909c169e..8e4b6f8567a 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -78,13 +78,13 @@ A job is defined by a list of parameters that define the job behavior. ### `extends` -> Introduced in GitLab 11.3 +> Introduced in GitLab 11.3. -`extends` defines an entry name that a job, that uses `extends` is going to +`extends` defines an entry name that a job that uses `extends` is going to inherit from. -`extends` in an alternative to using [YAML anchors](#anchors) that is a little -more flexible and readable. +It is an alternative to using [YAML anchors](#anchors) and is a little +more flexible and readable: ```yaml .tests: @@ -102,10 +102,10 @@ rspec: - $RSPEC ``` -In the example above the `rspec` job is going to inherit from `.tests` -template. GitLab will perform a reverse deep merge, what means that it will -merge `rspec` contents into `.tests` recursively, and it is going to result in -following configuration of the `rspec` job: +In the example above, the `rspec` job is going to inherit from the `.tests` +template job. GitLab will perform a reverse deep merge, which means that it will +merge the `rspec` contents into `.tests` recursively, and this is going to result in +the following `rspec` job: ```yaml rspec: @@ -118,13 +118,12 @@ rspec: - $RSPEC ``` -`.tests` in this example is a [hidden key](#hidden-keys-jobs), but it is +`.tests` in this example is a [hidden key](#hidden-keys-jobs), but it's possible to inherit from regular jobs as well. `extends` supports multi-level inheritance, however it is not recommended to -use more than three levels of inheritance. Maximum nesting level supported is -10 levels. - +use more than three levels. The maximum nesting level that is supported is 10. +The following example has two levels of inheritance: ```yaml .tests: @@ -150,6 +149,8 @@ spinach: script: rake spinach ``` +`extends` works across configuration files combined with [`include`](#include). + ### `pages` `pages` is a special job that is used to upload static content to GitLab that |