jjb
/
jenkins-job-builder
Code Issues Proposed changes

Merge "Document the Zuul triggers"

This commit is contained in:
Jenkins 2014-07-10 16:10:51 +00:00 committed by Gerrit Code Review
parent 04139e0f5e 965fdc2379
commit b0d117a404
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
jenkins_jobs/modules/zuul.py
View File

@ -13,7 +13,14 @@
# under the License.
"""
The Zuul module adds triggers that configure jobs for use with Zuul_.
The Zuul module adds triggers that configure jobs for use with Zuul_. It
essentially adds the jobs parameters `expected by Zuul`_.
With Zuul version 2.0 and later, this is optional. The jobs are
triggered via the Jenkins Gearman plugin which passes the parameters
internally. You might still want to explicitly define parameters to
retain the possibility of triggering jobs manually via the Jenkins web
interface (build with parameters).
To change the Zuul notification URL, set a global default::
@ -24,6 +31,8 @@ To change the Zuul notification URL, set a global default::
The above URL is the default.
.. _Zuul: http://ci.openstack.org/zuul/
.. _expected by Zuul: \
http://ci.openstack.org/zuul/launchers.html#zuul-parameters
"""
@ -31,6 +40,11 @@ def zuul():
"""yaml: zuul
Configure this job to be triggered by Zuul.
Adds parameters describing the change triggering the build such as the
branch name, change number and patchset.
See parameters `expected by Zuul`_.
Example::
triggers:
@ -42,6 +56,12 @@ def zuul_post():
"""yaml: zuul-post
Configure this post-merge job to be triggered by Zuul.
Adds parameters describing the reference update triggering the build, which
are the previous and next revisions in full (40 hexadecimal sha1) and short
form.
See parameters `expected by Zuul`_.
Example::
triggers: