openstack/governance
Code Issues Proposed changes
b927391fbb
governance/tox.ini

72 lines
1.7 KiB
INI
Raw Normal View History

provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
[tox]
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
envlist = docs,linters
Cleanup py27 support This repo is now testing only with Python 3, so let's make a few cleanups: - Remove obsolete sections from setup.cfg - Use newer openstackdocstheme and Sphinx versions for Python3 - Cleanup */source/conf.py to remove now obsolete content. - Remove install_command from tox.ini, the default is fine - Move python3 to testenv in tox.ini - Switch to hacking 3, fix problems found. Change-Id: I26fcab3b288b5ed64c74f7a6725b43036f195d44
2020-04-17 17:31:14 +02:00
minversion = 3.1.1
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
skipsdist = True
Cleanup py27 support This repo is now testing only with Python 3, so let's make a few cleanups: - Remove obsolete sections from setup.cfg - Use newer openstackdocstheme and Sphinx versions for Python3 - Cleanup */source/conf.py to remove now obsolete content. - Remove install_command from tox.ini, the default is fine - Move python3 to testenv in tox.ini - Switch to hacking 3, fix problems found. Change-Id: I26fcab3b288b5ed64c74f7a6725b43036f195d44
2020-04-17 17:31:14 +02:00
ignore_basepython_conflict = True
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
[testenv]
begin conversion to rst This converts 2 of the reference documents to rst, and fixes the tox.ini so that tox -e docs creates a pretty html version of these documents. While the publish target location has still not been sorted this moves the ball forward in generating nicer output for the documents. The incubation-integration-requirements document was intentionally left out, because it's much more active, and we should decide this is the right approach before we impose the merge conflicts on everyone in flight. Change-Id: I2fefdb5efe196cdbda4555141b09e7e771e20bdd
2014-04-15 08:24:17 -04:00
usedevelop = True
Cleanup py27 support This repo is now testing only with Python 3, so let's make a few cleanups: - Remove obsolete sections from setup.cfg - Use newer openstackdocstheme and Sphinx versions for Python3 - Cleanup */source/conf.py to remove now obsolete content. - Remove install_command from tox.ini, the default is fine - Move python3 to testenv in tox.ini - Switch to hacking 3, fix problems found. Change-Id: I26fcab3b288b5ed64c74f7a6725b43036f195d44
2020-04-17 17:31:14 +02:00
basepython = python3
add module for fetching and parsing governance data Change-Id: I7279023e5d81554e19f315fe12ab6fdb988af934 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-10-12 13:20:19 -04:00
setenv =
VIRTUAL_ENV={envdir}
PYTHON=coverage run --source openstack_governance --parallel-mode
OS_STDOUT_CAPTURE=1
OS_STDERR_CAPTURE=1
OS_DEBUG=1
OS_LOG_CAPTURE=1
deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands =
stestr run '{posargs}'
coverage combine
coverage html -d cover
coverage xml -o cover/coverage.xml
coverage report --show-missing
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
[testenv:linters]
fix tox python3 overrides We want to default to running all tox environments under python 3, so set the basepython value in each environment. We do not want to specify a minor version number, because we do not want to have to update the file every time we upgrade python. We do not want to set the override once in testenv, because that breaks the more specific versions used in default environments like py35 and py36. Change-Id: I13cd6b83388368966868f90ae09c88a3c644114f
2018-06-09 01:16:41 +08:00
basepython = python3
Reduce the scope of yamllints coverage Since I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db the non-voting linters target has been failign as it was also checking yaml files in the virtualenvs created by tox [1]. This change modifies the way we invoke yamllint so that only files we actually care about are linted. We also configure yamllint to have a slight more generous line-length limit and to disable the 'truthy'[2] rule. [1] http://logs.openstack.org/10/382110/2/check/gate-governance-linters-ubuntu-xenial/6c8ae21/console.html#_2016-10-11_15_39_52_575891 [2] https://yamllint.readthedocs.io/en/latest/rules.html#module-yamllint.rules.truthy Change-Id: Ia0337aa49efb9ec832356eed374cc56bac1e75bc
2016-10-18 14:09:41 +11:00
whitelist_externals = bash
add flake8 to the linter job Turn on flake8 for code style checks, like in our other repos. Fix or explicitly ignore various issues to allow the linter job to pass. Change-Id: I7bfd8cf5e9c00dfa83c0393a4307fd54d2113047 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-03-15 17:08:53 -04:00
commands =
add jsonschema validation for project data This change adds a tool to perform basic JSONSchema validation of the reference/projects.yaml file. Change-Id: I28ff94af37d7f4de07c1d282bf3c37c77eeea101 Signed-off-by: Doug Hellmann <doug@doughellmann.com> Co-Authored-by: Zane Bitter <zbitter@redhat.com>
2019-07-30 15:18:00 -04:00
osg-check-schema
add flake8 to the linter job Turn on flake8 for code style checks, like in our other repos. Fix or explicitly ignore various issues to allow the linter job to pass. Change-Id: I7bfd8cf5e9c00dfa83c0393a4307fd54d2113047 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-03-15 17:08:53 -04:00
bash -c "find {toxinidir} \
Reduce the scope of yamllints coverage Since I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db the non-voting linters target has been failign as it was also checking yaml files in the virtualenvs created by tox [1]. This change modifies the way we invoke yamllint so that only files we actually care about are linted. We also configure yamllint to have a slight more generous line-length limit and to disable the 'truthy'[2] rule. [1] http://logs.openstack.org/10/382110/2/check/gate-governance-linters-ubuntu-xenial/6c8ae21/console.html#_2016-10-11_15_39_52_575891 [2] https://yamllint.readthedocs.io/en/latest/rules.html#module-yamllint.rules.truthy Change-Id: Ia0337aa49efb9ec832356eed374cc56bac1e75bc
2016-10-18 14:09:41 +11:00
\( -name .tox -prune \) \
-o -type f -name '*.yaml' \
-print0 | xargs -0 yamllint"
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
{toxinidir}/tools/check_projects_yaml_alphabetized.sh
add flake8 to the linter job Turn on flake8 for code style checks, like in our other repos. Fix or explicitly ignore various issues to allow the linter job to pass. Change-Id: I7bfd8cf5e9c00dfa83c0393a4307fd54d2113047 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-03-15 17:08:53 -04:00
flake8
add redirect for renamed top-5-list file Add the redirect instructions and add whereto as a step in the linters build to ensure that all redirects are being tested. Change-Id: Ib8ea0be2e063a7972f3a6ad71c32921512796136 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-12-11 10:43:23 -05:00
whereto {toxinidir}/doc/source/_extra/.htaccess {toxinidir}/doc/test/redirect-tests.txt
add validation for new repositories Require new repositories to exist in the gerrit project data managed by the infra team before they can be added to governance. Change-Id: Ic465e415d5253d2a918c3cd3ec8861f672360834 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-18 09:56:55 -04:00
{toxinidir}/tools/validate_repositories.py
Make validate atcs optional Without this patch, a change of membership of any ATC could break the lint jobs. This is a problem, as the change of membership can happen anytime. This fixes it by creating a new job to show whether atc validation fails or not, as non voting. This brings increased visibility to the eventual membership problems, compared to having them listed in stdout like we used to do in the past. Change-Id: I5cb3dee7809d80369eaf8c955695b1389f5eb5d4
2019-12-23 12:43:28 +01:00
Add legacy repository validation This patch improves the legacy repository validation by ensuring that we actually make sure the repository is properly retired. This job will only run on changes to the legacy.yaml file to avoid a high number of API calls. Change-Id: I40f1818955eaa0a2037f239aeced86c3faf3281e
2020-06-23 11:09:49 -04:00
[testenv:validate-legacy]
envdir = {toxworkdir}/linters
commands =
{toxinidir}/tools/validate-legacy.py
Make validate atcs optional Without this patch, a change of membership of any ATC could break the lint jobs. This is a problem, as the change of membership can happen anytime. This fixes it by creating a new job to show whether atc validation fails or not, as non voting. This brings increased visibility to the eventual membership problems, compared to having them listed in stdout like we used to do in the past. Change-Id: I5cb3dee7809d80369eaf8c955695b1389f5eb5d4
2019-12-23 12:43:28 +01:00
[testenv:validate_atcs]
commands = {toxinidir}/tools/validate_atcs.py
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
add pep8 to tox.ini Add a separate pep8 environment in tox.ini for linting only the code changes. We don't need to add the zuul job because flake8 also runs as part of the linters environment and job. Change-Id: Ie6bbdfdecef43666cb0eb5d3ff4a34a7067daed2 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-10-12 14:58:28 -04:00
[testenv:pep8]
commands =
flake8
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
[testenv:venv]
commands = {posargs}
begin conversion to rst This converts 2 of the reference documents to rst, and fixes the tox.ini so that tox -e docs creates a pretty html version of these documents. While the publish target location has still not been sorted this moves the ball forward in generating nicer output for the documents. The incubation-integration-requirements document was intentionally left out, because it's much more active, and we should decide this is the right approach before we impose the merge conflicts on everyone in flight. Change-Id: I2fefdb5efe196cdbda4555141b09e7e771e20bdd
2014-04-15 08:24:17 -04:00
[testenv:docs]
Add doc/requirements This project isn't released but uniformization can't hurt. The origin of these changes was that 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 could meet similar 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: Ie0c8db6331630c5d3a379a9c8c2d87eb0a8fd207
2021-01-07 10:49:37 +01:00
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
Clean generated files before run in docs target Change-Id: Ia7f35bec67c90a907d87d089fc596b203f405a26
2022-02-10 11:38:01 -08:00
whitelist_externals =
find
rm
commands =
rm -Rf doc/build
find reference/projects -name '*.rst' -a '!' -name index.rst -delete
sphinx-build -W -b html doc/source doc/build/html
Add tox env for validate_tags script This way the script can be run as: $tox -e validate Change-Id: Ia90bd02ab2e20dd99d613f91c9cd6b92eb9d94d8
2015-12-20 15:16:49 -05:00
add check_review_status.py I have been using this script to apply the house rules to governance changes to help track when they are ready to be approved. I thought it would be good to share it for others to be able to see and review the work. Change-Id: I41e3338858f546705e78ce5428a09dfe3b904947 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-03 15:01:34 -04:00
[testenv:check-review-status]
deps =
requests
prettytable
Make validate atcs optional Without this patch, a change of membership of any ATC could break the lint jobs. This is a problem, as the change of membership can happen anytime. This fixes it by creating a new job to show whether atc validation fails or not, as non voting. This brings increased visibility to the eventual membership problems, compared to having them listed in stdout like we used to do in the past. Change-Id: I5cb3dee7809d80369eaf8c955695b1389f5eb5d4
2019-12-23 12:43:28 +01:00
commands = {toxinidir}/tools/check_review_status.py
Copy Permalink