summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-12-14 13:54:22 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2018-12-14 13:54:22 +0000
commit703cd967278f7ef47ff058d39ce802b53e52993f (patch)
tree0073ae84c49c816ed217baec7aa7235f0fb54421
parent51e07381c7319e20f99353736c464d3704d29f4d (diff)
parent7827eae5b2e1c8a019a8ce859f45ff4936e57227 (diff)
downloadgitlab-ce-703cd967278f7ef47ff058d39ce802b53e52993f.tar.gz
Merge branch 'patch-13' into 'master'
doc/ci/yaml: improve wording to explain better deep vs recursive merging See merge request gitlab-org/gitlab-ce!22542
-rw-r--r--doc/ci/yaml/README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 4dafde0462a..01f4b023234 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -1716,13 +1716,17 @@ include:
---
-Since GitLab 10.8 we are now recursively merging the files defined in `include`
+Since GitLab 10.8 we are now deep merging the files defined in `include`
with those in `.gitlab-ci.yml`. Files defined by `include` are always
-evaluated first and recursively merged with the content of `.gitlab-ci.yml`, no
+evaluated first and merged with the content of `.gitlab-ci.yml`, no
matter the position of the `include` keyword. You can take advantage of
-recursive merging to customize and override details in included CI
+merging to customize and override details in included CI
configurations with local definitions.
+NOTE: **Note:**
+The recursive includes are not supported, meaning your external files
+should not use the `include` keyword, as it will be ignored.
+
The following example shows specific YAML-defined variables and details of the
`production` job from an include file being customized in `.gitlab-ci.yml`.
@@ -1772,11 +1776,7 @@ with the environment url of the `production` job defined in
`autodevops-template.yml` have been overridden by new values defined in
`.gitlab-ci.yml`.
-NOTE: **Note:**
-Recursive includes are not supported meaning your external files
-should not use the `include` keyword, as it will be ignored.
-
-Recursive merging lets you extend and override dictionary mappings, but
+The merging lets you extend and override dictionary mappings, but
you cannot add or modify items to an included array. For example, to add
an additional item to the production job script, you must repeat the
existing script items.