From fea7fa2d9cc7a583083e00ccaaffbdcdea1fe385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Beraud?= Date: Tue, 5 Jan 2021 09:49:46 +0100 Subject: [PATCH] Add doc/requirements 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. /!\/!\/!\ Notice that I voluntarily added the doc directory even if no docs are generated here because zuul will try to pull this requirements from there first and the contained requirements are needed for reno but AFAIK the releasenotes dir is ignored by zuul. c.f [4] for further details. /!\/!\/!\ [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: I519ef389448acb3dde328a0e61c074e48d7e0466 --- doc/requirements.txt | 3 +++ test-requirements.txt | 3 --- tox.ini | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..a7901f5183 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=1.8.0,!=2.1.0 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/test-requirements.txt b/test-requirements.txt index e11f7e2c1c..36bb9c41fb 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,12 +2,9 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. hacking>=3.0.1,<3.1.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 PyYAML>=3.12 # MIT Jinja2>=2.10 # BSD License (3 clause) six>=1.10.0 # MIT -sphinx>=1.8.0,!=2.1.0 # BSD -reno>=2.5.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD python-subunit>=1.0.0 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index d03988715c..532c98c7a1 100644 --- a/tox.ini +++ b/tox.ini @@ -60,6 +60,8 @@ commands = python ./tools/process-templates.py commands = python ./tools/process-templates.py -c [testenv:releasenotes] +deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt whitelist_externals = bash commands = bash -c tools/releasenotes_tox.sh