| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 1 | :title: Zuul Driver |
| 2 | |
| 3 | Zuul |
| 4 | ==== |
| 5 | |
| 6 | The Zuul driver supports triggers only. It is used for triggering |
| 7 | pipelines based on internal Zuul events. |
| 8 | |
| 9 | Trigger Configuration |
| 10 | --------------------- |
| 11 | |
| 12 | Zuul events don't require a special connection or driver. Instead they |
| James E. Blair | 9b0d277 | 2017-08-04 08:48:52 -0700 | [diff] [blame] | 13 | can simply be used by listing ``zuul`` as the trigger. |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 14 | |
| James E. Blair | 9b0d277 | 2017-08-04 08:48:52 -0700 | [diff] [blame] | 15 | .. attr:: pipeline.trigger.zuul |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 16 | |
| James E. Blair | 9b0d277 | 2017-08-04 08:48:52 -0700 | [diff] [blame] | 17 | The Zuul trigger supports the following attributes: |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 18 | |
| James E. Blair | 9b0d277 | 2017-08-04 08:48:52 -0700 | [diff] [blame] | 19 | .. attr:: event |
| 20 | :required: |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 21 | |
| James E. Blair | 9b0d277 | 2017-08-04 08:48:52 -0700 | [diff] [blame] | 22 | The event name. Currently supported events: |
| 23 | |
| 24 | .. value:: project-change-merged |
| 25 | |
| 26 | When Zuul merges a change to a project, it generates this |
| 27 | event for every open change in the project. |
| 28 | |
| 29 | .. value:: parent-change-enqueued |
| 30 | |
| 31 | When Zuul enqueues a change into any pipeline, it generates |
| 32 | this event for every child of that change. |
| 33 | |
| 34 | .. attr:: pipeline |
| 35 | |
| 36 | Only available for ``parent-change-enqueued`` events. This is |
| 37 | the name of the pipeline in which the parent change was |
| 38 | enqueued. |