opendev/system-config
Code Issues Proposed changes

Use zuul-sphinx README.rst detection

Browse Source 
With the dependent change, zuul-sphinx will raise a warning when the
autoroles matcher finds a role without a README.rst.  Since we
error-on-warnings this will stop the docs build.  Thus we don't need
this explicit linters check.

Change-Id: I02eefce2448152505bacba3b2a12021515b4a31a
Depends-On: https://review.openstack.org/596014
This commit is contained in:
Ian Wienand 2018-08-24 17:59:28 +10:00
parent 36386394ca
commit a6c2fb53e7
2 changed files with 0 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tools/check_readme.sh
View File

@ -1,9 +0,0 @@
#!/bin/bash
# Trivial script run from tox -e linters to ensure roles have a
# README.rst attached
if ! [ -f $1/README.rst ]; then
echo "*** Missing role documentation: $1/README.rst"
exit 1
fi

2
tox.ini
View File

@ -12,8 +12,6 @@ deps = -r{toxinidir}/test-requirements.txt
[testenv:linters]
whitelist_externals = bash
commands =
bash -c "find roles/ playbooks/roles -maxdepth 1 -mindepth 1 -type d -print0 | \
xargs -t -n1 -0 {toxinidir}/tools/check_readme.sh"
flake8
{toxinidir}/tools/run-bashate.sh
python3 {toxinidir}/tools/sorted_modules_env.py {toxinidir}/modules.env