summaryrefslogtreecommitdiffstats
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/execution.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/execution.rst b/doc/source/execution.rst
index f8adc683..7434be72 100644
--- a/doc/source/execution.rst
+++ b/doc/source/execution.rst
@@ -57,6 +57,15 @@ job_builder section
so user can be sure which instance was updated. User may click the link to
go directly to that job. False by default.
+**retain_anchors**
+ (Optional) If set to True, YAML anchors will be retained across files,
+ allowing jobs to be composed from bits of YAML defined in separate files.
+ Note this means that the order of processing files matters - `jenkins-jobs`
+ loads files in alphabetical order (all files in a dir are loaded before any
+ files in subdirs). For example, if your anchors are in a file named `foo.yml`
+ they will be accessible in `qux.yml` but not in `bar.yml`. They will also be
+ accessible in `mydir/bar.yml` and `mydir/qux.yml`. False by default.
+
jenkins section
^^^^^^^^^^^^^^^