jjb/jenkins-job-builder
Code Issues Proposed changes

Add note regarding a bug with !include-raw-escape

Browse Source 
This spawned from discussions on the mailing list:
http://lists.openstack.org/pipermail/openstack-infra/2017-March/005233.html

Change-Id: I7916ebec86350fa760bb02b6bde38e27c71dc359
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
This commit is contained in:
Thanh Ha 2017-03-16 18:50:47 -04:00
parent 161473d1b7
commit 111f4512d5
No known key found for this signature in database
GPG Key ID: B0CB27E00DA095AA
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/execution.rst
View File

@ -25,7 +25,7 @@ job_builder section
**include_path** **include_path**
(Optional) Can be set to a ':' delimited list of paths, which jenkins (Optional) Can be set to a ':' delimited list of paths, which jenkins
job builder will search for any files specified by the custom application job builder will search for any files specified by the custom application
yaml tags 'include', 'include-raw' and 'include-raw-escaped'. yaml tags 'include', 'include-raw' and 'include-raw-escape'.
**recursive** **recursive**
(Optional) If set to True, jenkins job builder will search for job (Optional) If set to True, jenkins job builder will search for job

9
jenkins_jobs/local_yaml.py
View File

@ -65,6 +65,15 @@ before being read in as string data. This allows job-templates to use this tag
to include scripts from files without needing to escape braces in the original to include scripts from files without needing to escape braces in the original
file. file.
.. warning::
When used as a macro ``!include-raw-escape:`` should only be used if
parameters are passed into the escaped file and you would like to escape
those parameters. If the file does not have any jjb parameters passed into
it then ``!include-raw:`` should be used instead otherwise you will run
into an interesting issue where ``include-raw-escape:`` actually adds
additional curly braces around existing curly braces. For example
${PROJECT} becomes ${{PROJECT}} which may break bash scripts.
Examples: Examples: