blob: 8c12138653682ef974b776211c29d5499774e46a [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
Thanh Ha33ccffe2016-01-24 21:32:25 -050016 quick-start
James E. Blaircdd00072012-06-08 19:17:28 -070017 gating
Joshua Heskethfe485c62015-08-11 23:42:34 +100018 connections
James E. Blaircdd00072012-06-08 19:17:28 -070019 triggers
Joshua Hesketh1879cf72013-08-19 14:13:15 +100020 reporters
James E. Blaircdd00072012-06-08 19:17:28 -070021 zuul
Joshua Heskethfe485c62015-08-11 23:42:34 +100022 merger
Antoine Musso45dd2cb2014-01-29 17:17:43 +010023 cloner
Joshua Heskethfe485c62015-08-11 23:42:34 +100024 launchers
Antoine Mussoa8eea7d2013-10-05 16:08:00 +020025 statsd
Joshua Heskethfe485c62015-08-11 23:42:34 +100026 client
Monty Taylor82dfd412016-07-29 12:01:28 -070027 internals
James E. Blaircdd00072012-06-08 19:17:28 -070028
29Indices and tables
30==================
31
32* :ref:`genindex`
33* :ref:`modindex`
34* :ref:`search`
35