summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorVicky Chijwani <vickychijwani@gmail.com>2018-05-30 18:20:29 +0530
committerVicky Chijwani <vickychijwani@gmail.com>2018-05-31 20:30:09 +0530
commit75d78b65409632c14577ba0cce74bfe2e6d3765a (patch)
treec10fe49a0b4ad6238fc53ac96e1c2dc4f76f02df /doc
parent307c09cff3ef030a72859cdc63ce555810af486d (diff)
downloadpython-jenkins-job-builder-75d78b65409632c14577ba0cce74bfe2e6d3765a.tar.gz
python-jenkins-job-builder-75d78b65409632c14577ba0cce74bfe2e6d3765a.tar.xz
python-jenkins-job-builder-75d78b65409632c14577ba0cce74bfe2e6d3765a.zip
Add retain_anchors config option.
If set to True, YAML anchors can be referenced across files, allowing jobs to be composed from bits of YAML defined in separate files. False by default. Story: 2000338 Task: 2547 Change-Id: I034ce3bce0030093cb8d4266dabbdb06d96306d6
Diffstat (limited to 'doc')
-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
^^^^^^^^^^^^^^^