The Gatekeeper, or a project gating system
Go to file
James E. Blair 07ab843dd3 Pin tox to 3
There are many issues with toxv4 that make it difficult to use with
Zuul.  Pin to tox version 3 while we find a solution.

Change-Id: I608b2ad4ab9407d8a0b77d5def5188922875e00f
2022-12-15 13:08:02 -08:00
doc Merge "Add Gerrit Verified/Workflow submit reqs to tutorial" 2022-12-01 08:20:16 +00:00
etc Remove "sql connection" backwards compatability for database 2022-01-25 16:07:08 -08:00
playbooks tutorial: remove warn parameter from 'shell' ansible module 2022-11-24 21:01:35 +01:00
releasenotes/notes Merge "Detect errors with non-permitted parent jobs" 2022-11-15 14:03:38 +00:00
tests Merge "Consider queue settings for topic dependencies" 2022-12-13 15:07:49 +00:00
tools Only run yarn build when necessary in tools/ 2022-10-07 13:29:25 -07:00
web Fix config-errors dedicated page 2022-11-02 08:45:17 -07:00
zuul Merge "Avoid acquiring pipeline locks in manager postConfig" 2022-12-13 18:07:16 +00: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 Use ZooKeeper TLS in tests 2021-03-08 06:49:57 -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 Pin tox to 3 2022-12-15 13:08:02 -08:00
COPYING Update README and add GPL license 2018-03-19 09:25:52 -07:00
Dockerfile Add Python 3.11 testing 2022-10-27 16:47:14 -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 Bump up to python3.10 2022-07-01 15:59:48 -07:00
reno.yaml Add reno configuration settings 2020-07-22 08:45:46 -07:00
requirements.txt Unpin JWT and use integer IAT values 2022-11-15 13:52:53 -08:00
setup.cfg Add Python 3.11 testing 2022-10-27 16:47:14 -07:00 Partial sync with OpenStack requirements. 2013-09-25 15:30:37 -07:00
test-requirements.txt github: more complete mocking for app setup 2021-09-23 19:53:48 +10:00
tox.ini Update unit test container setup and instructions 2022-08-05 21:00:02 +00: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.