Ansible job definitions for Zuul
Go to file
Stephen Finucane a258aa9a3b Default warning-is-error to True for non-legacy Sphinx projects
We're trying to move away from the legacy pbr 'build_sphinx' command.
However, without the relevant section in the 'setup.cfg' file, we have
no way to determine if the user wishes to use the '-W'
(warning-is-error) flag when building docs. The current behavior for
this is to default to False, meaning documentation for projects that
previously used the pbr functionality to enable warning-is-error is
liable to slowly break as time passes.

To resolve this, default to True for packages with no [build_sphinx]
section in setup.cfg. This ensures that projects migrating to the new
PTI (which, when fully implemented, involves removing the [build_sphinx]
section from setup.cfg) will be forced to fix any warnings prior to the
migration. However, packages that have not been converted will not be
broken. Only pacakges that have already fully switched over to the new
PTI but which did not have warning-is-error enabled are at risk of
unexpected breakage, but even for those the short-term pain should
ultimately be outweighed by the long-term gain.

Change-Id: I677afef96370ead5a45cba854ba483f18a8d1247
2018-05-10 09:23:57 +01:00
doc/source Fix pep8/yamllint errors 2018-01-02 06:43:26 +00:00
playbooks Revert "Revert "Deploy the build ssh key to auth_keys"" 2018-03-06 18:51:30 +00:00
roles Default warning-is-error to True for non-legacy Sphinx projects 2018-05-10 09:23:57 +01:00
tests Include ansible-playbook syntax-check for tox pep8 2017-07-17 16:53:55 -04:00
.gitignore Add Sphinx module for Zuul jobs 2017-06-09 09:03:15 -07:00
.gitreview Added .gitreview 2017-05-24 19:48:52 +00:00
bindep.txt Port in tox jobs from openstack-zuul-jobs 2017-07-06 11:18:47 -05:00
LICENSE Add initial license, docs, and other config 2017-06-08 14:01:21 -07:00
README.rst Add initial license, docs, and other config 2017-06-08 14:01:21 -07:00
setup.cfg Add initial license, docs, and other config 2017-06-08 14:01:21 -07:00
setup.py Add initial license, docs, and other config 2017-06-08 14:01:21 -07:00
test-requirements.txt Run ansible-lint on repo 2017-10-27 07:49:02 +02:00
tox.ini Fix ansible-lint job 2018-03-28 23:10:22 +02:00
zuul.yaml Merge "Fix typo in build-sphinx-docs docstring" 2018-04-13 00:39:24 +00:00

Zuul Jobs

This repo contains a set of Zuul jobs and Ansible roles suitable for use by any Zuul system.