blob: 61f9e4f579a856637241cd0bd01b903e0e7fea9c [file] [log] [blame]
James E. Blaircdd00072012-06-08 19:17:28 -07001Zuul - A Project Gating System
2==============================
3
4Zuul is a program that is used to gate the source code repository of a
5project so that changes are only merged if they pass tests.
6
7The main component of Zuul is the scheduler. It receives events
James E. Blair1f4c2bb2013-04-26 08:40:46 -07008related to proposed changes, triggers tests based on those events, and
9reports back.
James E. Blaircdd00072012-06-08 19:17:28 -070010
11Contents:
12
13.. toctree::
14 :maxdepth: 2
15
16 gating
Joshua Heskethfe485c62015-08-11 23:42:34 +100017 connections
James E. Blaircdd00072012-06-08 19:17:28 -070018 triggers
Joshua Hesketh1879cf72013-08-19 14:13:15 +100019 reporters
James E. Blaircdd00072012-06-08 19:17:28 -070020 zuul
Joshua Heskethfe485c62015-08-11 23:42:34 +100021 merger
Antoine Musso45dd2cb2014-01-29 17:17:43 +010022 cloner
Joshua Heskethfe485c62015-08-11 23:42:34 +100023 launchers
Antoine Mussoa8eea7d2013-10-05 16:08:00 +020024 statsd
Joshua Heskethfe485c62015-08-11 23:42:34 +100025 client
James E. Blaircdd00072012-06-08 19:17:28 -070026
27Indices and tables
28==================
29
30* :ref:`genindex`
31* :ref:`modindex`
32* :ref:`search`
33