zuul
/
zuul
Code Issues Proposed changes

Merge "Correct run job parameter documentation" into feature/zuulv3

This commit is contained in:
Jenkins 2017-07-12 22:28:38 +00:00 committed by Gerrit Code Review
parent c0b5ef33ba 2aade26781
commit 5028172b89
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/user/config.rst
View File

@ -662,32 +662,35 @@ unless otherwise specified:
of attempts to make before an error is reported. Default: 3. of attempts to make before an error is reported. Default: 3.
**pre-run** **pre-run**
The name of a playbook or list of playbooks to run before the main The name of a playbook or list of playbooks without file extension
body of a job. The playbook is expected to reside in the to run before the main body of a job. The full path to the playbook
`playbooks/` directory of the project where the job is defined. in the repo where the job is defined is expected.
When a job inherits from a parent, the child's pre-run playbooks are When a job inherits from a parent, the child's pre-run playbooks are
run after the parent's. See :ref:`job` for more information. run after the parent's. See :ref:`job` for more information.
**post-run** **post-run**
The name of a playbook or list of playbooks to run after the main The name of a playbook or list of playbooks without file extension
body of a job. The playbook is expected to reside in the to run after the main body of a job. The full path to the playbook
`playbooks/` directory of the project where the job is defined. in the repo where the job is defined is expected.
When a job inherits from a parent, the child's post-run playbooks When a job inherits from a parent, the child's post-run playbooks
are run before the parent's. See :ref:`job` for more information. are run before the parent's. See :ref:`job` for more information.
**run** **run**
The name of the main playbook for this job. This parameter is not The name of the main playbook for this job. This parameter is
normally necessary, as it defaults to the name of the job. However, not normally necessary, as it defaults to a playbook with the
if a playbook with a different name is needed, it can be specified same name as the job inside of the `playbooks/` directory (e.g.,
here. The playbook is expected to reside in the `playbooks/` the `foo` job would default to `playbooks/foo`. However, if a
directory of the project where the job is defined. When a child playbook with a different name is needed, it can be specified
inherits from a parent, a playbook with the name of the child job is here. The file extension is not required, but the full path
implicitly searched first, before falling back on the playbook used within the repo is. When a child inherits from a parent, a
by the parent job (unless the child job specifies a ``run`` playbook with the name of the child job is implicitly searched
attribute, in which case that value is used). Default: the name of first, before falling back on the playbook used by the parent
the job. job (unless the child job specifies a ``run`` attribute, in which
case that value is used). Example::
run: playbooks/<name of the job>
**roles** **roles**
A list of Ansible roles to prepare for the job. Because a job runs A list of Ansible roles to prepare for the job. Because a job runs