The Gatekeeper, or a project gating system
Go to file
James E. Blair 9eef4e532a Don't run jobs if only their file matchers are updated
Normally, if a change is made to a job configuration, we want to
ignore the file matchers and run the job so that we can see the
update in practice.  However, we don't want to do so if the
*only* change to the job configuration is the file matchers.  The
result is no different than before, and running the job tells us
nothing about the value of the change.

This behavior was already the case, but due to a bug.  This
change both fixes the bug and intentionally restores the
behavior.

The bug that is corrected is that when variants were applied, the
actual file matchers attached to the frozen job were updated, but
not their string/list representation (stored in the '_files' and
'_irrelevant_files' attributes).  This change moves those
attributes to the list of context attributes (which are
automatically copied on inheritance) -- the same as the actual
matcher attributes.

We also do the same for the '_branches' attribute (the text
version of the branch matcher).  These changes make the
serialized form of the frozen job (which is returned by the web
api) more accurate.  And in the case of the files matchers,
causes Zuul to correctly detect that the job has changed when
they are updated.

To restore the current (accidental but desired) behavior, we now
pop the files and irrelevant-files keys from the serialized
representation of the job before comparison when deciding whether
to run the job during a config update.  This means that it will
only run if something other than a files matcher is changed.

This change also removes the _implied_branch job attribute
because it is no longer used anywhere (implied branches now
arrive via projects and project templates).

Change-Id: Id1d595873fe87ca980b2f33832f55542f9e5d496
2020-02-07 07:16:25 -08:00
doc Add Zuul's event id to Ansible inventory 2020-02-06 11:32:48 +01:00
etc authentication config: add optional max_validity_time, skew 2019-12-10 16:39:29 +01:00
playbooks Fix path in quick-start localtest 2020-01-27 10:31:35 -08:00
releasenotes/notes Change default Gerrit HTTP auth method 2020-01-24 09:59:16 +00:00
tests Don't run jobs if only their file matchers are updated 2020-02-07 07:16:25 -08:00
tools On CI, use a tmpfs for ZUUL_TEST_ROOT 2020-01-24 16:04:55 +01:00
web Don't run jobs if only their file matchers are updated 2020-02-07 07:16:25 -08:00
zuul Don't run jobs if only their file matchers are updated 2020-02-07 07:16:25 -08: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 Fix ignored but tracked .keep file 2018-12-02 09:12:25 +01: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 Increase timeout of zuul-build-image 2020-02-04 15:16:47 +01:00
COPYING Update README and add GPL license 2018-03-19 09:25:52 -07:00
Dockerfile Dockerfile: create a zuul user with uid 10001 2020-01-31 20:46:49 +00:00
LICENSE Initial commit. 2012-05-29 14:49:32 -07:00
MANIFEST.in manifest: add zuul/ansible and ansible-config.conf 2019-03-18 08:07:00 +00:00
README.rst Support nodes setting 'auto' python-path 2019-09-19 10:28:53 +10:00
TESTING.rst Docs: fix stestr run example 2020-01-21 10:36:07 +01:00
bindep.txt bindep: fixed wrong dep names on rpm platform 2020-01-20 14:30:10 +00:00
requirements.txt Cap cheroot to fix issues with concurrent requests 2020-02-03 16:30:50 +01:00
setup.cfg Cleanup executor specific requirements 2019-04-04 08:58:04 +02:00
setup.py Partial sync with OpenStack requirements. 2013-09-25 15:30:37 -07:00
test-requirements.txt tox: reduce deps used for pep8 env 2020-01-21 16:05:18 +01:00
tox.ini Merge "tox: reduce deps used for pep8 env" 2020-01-22 09:47:47 +00:00

README.rst

Zuul

Zuul is a project gating system.

The latest documentation for Zuul v3 is published at: https://zuul-ci.org/docs/zuul/

If you are looking for the Edge routing service named Zuul that is related to Netflix, it can be found here: https://github.com/Netflix/zuul

If you are looking for the Javascript testing tool named Zuul, it can be found here: https://github.com/defunctzombie/zuul

Getting Help

There are two Zuul-related mailing lists:

zuul-announce

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

zuul-discuss

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

You will also find Zuul developers in the #zuul channel on Freenode IRC.

Contributing

To browse the latest code, see: https://opendev.org/zuul/zuul To clone the latest code, use git clone https://opendev.org/zuul/zuul

Bugs are handled at: https://storyboard.openstack.org/#!/project/zuul/zuul

Suspected security vulnerabilities are most appreciated if first reported privately following any of the supported mechanisms described at https://zuul-ci.org/docs/zuul/user/vulnerabilities.html

Code reviews are handled by gerrit at https://review.opendev.org

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

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

Join #zuul on Freenode to discuss development or usage.

License

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.