blob: a875457f2ae33c707399d8ed3ad818e86a5008c1 [file] [log] [blame]
James E. Blaireff5a9d2017-06-20 00:00:37 -07001:title: Zuul Driver
2
3Zuul
4====
5
6The Zuul driver supports triggers only. It is used for triggering
7pipelines based on internal Zuul events.
8
9Trigger Configuration
10---------------------
11
12Zuul events don't require a special connection or driver. Instead they
13can simply be used by listing **zuul** as the trigger.
14
15**event**
16The event name. Currently supported:
17
18 *project-change-merged* when Zuul merges a change to a project,
19 it generates this event for every open change in the project.
20
21 *parent-change-enqueued* when Zuul enqueues a change into any
22 pipeline, it generates this event for every child of that
23 change.
24
25**pipeline**
26Only available for ``parent-change-enqueued`` events. This is the
27name of the pipeline in which the parent change was enqueued.
28
29*require-approval*
30This may be used for any event. It requires that a certain kind
31of approval be present for the current patchset of the change (the
32approval could be added by the event in question). It follows the
33same syntax as the :ref:`"approval" pipeline requirement
34<pipeline-require-approval>`. For each specified criteria there must
35exist a matching approval.
36
37*reject-approval*
38This takes a list of approvals in the same format as
39*require-approval* but will fail to enter the pipeline if there is
40a matching approval.