openstack/tripleo-common
Code Issues Proposed changes

Add doc/requirements

Browse Source 
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file to
pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: I737a7d7f6781abb84bd5213d0723bb14a48eb89f
This commit is contained in:
Hervé Beraud 2021-01-05 09:25:33 +01:00
parent e05e6bdf13
commit 8e57c59eb5
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt Normal file
View File

@ -0,0 +1,4 @@
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
docutils>=0.11 # OSI-Approved Open Source, Public Domain
reno>=3.1.0 # Apache-2.0

5
test-requirements.txt
View File

@ -2,17 +2,12 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=2.2.1 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain
python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx>=2.0.0,!=2.1.0 # BSD
oslotest>=3.2.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
PyYAML>=3.12 # MIT
reno>=3.1.0 # Apache-2.0
urllib3>=1.21.1 # MIT
requests-mock>=1.2.0 # Apache-2.0

3
tox.ini
View File

@ -66,6 +66,8 @@ commands =
coverage report
[testenv:docs]
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html
@ -89,6 +91,7 @@ commands =
bash -c tools/check_duplicate_jinja_blocks.sh
[testenv:releasenotes]
deps = {[testenv:docs]deps}
commands = bash -c tools/releasenotes_tox.sh
[testenv:requirements]