zuul
/
zuul
Code Issues Proposed changes

Merge "docs: improve job.role documentation"

This commit is contained in:
Zuul 2020-01-21 21:51:21 +00:00 committed by Gerrit Code Review
parent 5d9dd4fc4e efb1470810
commit d58d51e450
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/reference/job_def.rst
View File

@ -505,6 +505,16 @@ Here is an example of two job definitions:
.. attr:: roles .. attr:: roles
.. code-block:: yaml
:name: job-roles-example
- job:
name: myjob
roles:
- zuul: myorg/our-roles-project
- zuul: myorg/ansible-role-foo
name: foo
A list of Ansible roles to prepare for the job. Because a job A list of Ansible roles to prepare for the job. Because a job
runs an Ansible playbook, any roles which are used by the job runs an Ansible playbook, any roles which are used by the job
must be prepared and installed by Zuul before the job begins. must be prepared and installed by Zuul before the job begins.
@ -559,10 +569,10 @@ Here is an example of two job definitions:
explicitly listing the project in the roles list in the usual explicitly listing the project in the roles list in the usual
way. way.
.. note:: Galaxy roles are not yet implemented.
.. attr:: galaxy .. attr:: galaxy
.. warning:: Galaxy roles are not yet implemented.
The name of the role in Ansible Galaxy. If this attribute is The name of the role in Ansible Galaxy. If this attribute is
supplied, Zuul will search Ansible Galaxy for a role by this supplied, Zuul will search Ansible Galaxy for a role by this
name and install it. Mutually exclusive with ``zuul``; name and install it. Mutually exclusive with ``zuul``;