The Gatekeeper, or a project gating system
Go to file
James E. Blair 762a96e571 Add buildset event db table
This adds a new database table, zuul_buildset_event, which stores
event information related to the buildset.  At the moment, the
only event information stored is a description of the trigger event
which originally caused the item to be enqueued.  Later changes may
add other events such as the reason the item was dequeued or
superceded, or the reason a buildset was canceled due to a gate reset.

A particular goal is to be able to inform users who see unsolicited
reports on their changes (which can happen due to a different change
in a dependency cycle being enqueued) understand why the report was

The new event information is exposed via the rest api and a later
change will add it to the web ui.

Change-Id: I9bcbb64faa3d499a26b90d20932009b6ce226061
2024-05-14 17:57:54 -07:00
doc Merge "Fix github docs for pull_request_review.state" 2024-03-25 19:53:18 +00:00
etc Remove "sql connection" backwards compatability for database 2022-01-25 16:07:08 -08:00
playbooks Add container image sanity checks 2024-03-22 06:32:56 -07:00
releasenotes/notes Merge "Emit per-branch queue stats separately" 2024-03-25 19:22:37 +00:00
tests Add buildset event db table 2024-05-14 17:57:54 -07:00
tools Add script to generate openapi spec 2024-03-09 11:25:40 -08:00
web Merge "Fix web dequeue of post items" 2024-03-19 18:00:48 +00:00
zuul Add buildset event db table 2024-05-14 17:57:54 -07:00
.coveragerc Revert "Revert "Switch to stestr"" 2018-05-17 08:33:40 -07:00
.dockerignore Add web/node_modules to dockerignore 2019-01-27 11:23:45 +01:00
.gitignore Add noxfile and switch to nox 2022-12-20 08:57:53 -08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:25:28 +00:00
.mailmap Fix pep8 E127 violations 2012-09-26 14:23:10 +00:00
.stestr.conf Revert "Revert "Switch to stestr"" 2018-05-17 08:33:40 -07:00
.zuul.yaml Merge "Add python 3.12 testing to Zuul" 2024-03-25 17:37:19 +00:00
COPYING Update README and add GPL license 2018-03-19 09:25:52 -07:00
Dockerfile Build a new skopeo for the zuul-executor container image 2024-03-21 12:48:32 -07:00
LICENSE Initial commit. 2012-05-29 14:49:32 -07:00 Optimize canMerge using graphql 2020-02-28 09:43:56 +01:00
README.rst Update README to point to Matrix, not IRC 2022-11-08 22:25:10 -08:00
TESTING.rst Update unit test container setup and instructions 2022-08-05 21:00:02 +00:00
bindep.txt Add python 3.12 testing to Zuul 2024-03-20 09:17:19 -07:00 Reduce unit test concurrency 2024-02-15 16:18:51 -08:00
reno.yaml Add reno configuration settings 2020-07-22 08:45:46 -07:00
requirements.txt Pin kazoo to 2.9.0 2024-02-15 16:18:15 -08:00
setup.cfg Add python 3.12 testing to Zuul 2024-03-20 09:17:19 -07:00 Partial sync with OpenStack requirements. 2013-09-25 15:30:37 -07:00
test-requirements.txt Add AWS Kinesis support 2023-07-25 11:04:19 -07:00
tox.ini Fix zk host env var for tests 2023-04-05 14:01:08 +02:00



Zuul is a project gating system.

The latest documentation for Zuul v3 is published at:

If you are looking for the Edge routing service named Zuul that is related to Netflix, it can be found here:

If you are looking for the Javascript testing tool named Zuul, it can be found here:

Getting Help

There are two Zuul-related mailing lists:


A low-traffic announcement-only list to which every Zuul operator or power-user should subscribe.


General discussion about Zuul, including questions about how to use it, and future development.

You will also find Zuul developers on Matrix <>.


To browse the latest code, see: To clone the latest code, use git clone

Bugs are handled at:!/project/zuul/zuul

Suspected security vulnerabilities are most appreciated if first reported privately following any of the supported mechanisms described at

Code reviews are handled by gerrit at

After creating a Gerrit account, use git review to submit patches. Example:

# Do your commits
$ git review
# Enter your username if prompted

Join us on Matrix to discuss development or usage.


Zuul is free software. Most of Zuul is licensed under the Apache License, version 2.0. Some parts of Zuul are licensed under the General Public License, version 3.0. Please see the license headers at the tops of individual source files.

Python Version Support

Zuul requires Python 3. It does not support Python 2.

Since Zuul uses Ansible to drive CI jobs, Zuul can run tests anywhere Ansible can, including Python 2 environments.