3c2e518c52
graphql queries (I77be4f16cf7eb5c8035ce0312f792f4e8d4c3e10) require authentication. Enqueueing changes from GitHub (including Depends-On) requires we run a graphql query. This means that Zuul must be able to authenticate either via an application or api_token to support features like Depends-On. If the app is setup (app_id in config) but we aren't installed with permissions on the project we're looking up, then fall back to using a specified api_token. This will make Depends-On work. Logging is updated to reflect whether or not we are able to fallback to the api_token if the application is not installed. We log the lack of an application installation at info level if we can fallback to the token, and log at error level if we're falling back to anonymous access. For backward compatibility we continue to fallback to anonymous access if neither an application install or api_token are present. The reason for this is features like Job required-projects: work fine anonymously, and there may be Zuul installations that don't need additional functionality. Keep in mind that authenticated requests to GitHub get larger API rate limits. Zuul installations should consider setting an API token even when using an application for this reason. This gives Zuul the best chance that fallback requests will not be rate limited. Documentation is updated, a changelog added and several test configuration files are padded with the required info. Story: #2008940 Change-Id: I2107aeafc55591eea790244701567569fa6e80d4
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 on Matrix <https://matrix.to/#/#zuul:opendev.org>.
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 promptedJoin us on Matrix 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.