Add README for tox role

Change-Id: I64e41fe95495208561d0ba79fce20a03227a466f
This commit is contained in:
Monty Taylor 2017-08-01 15:59:14 -05:00
parent f21bd3e57e
commit d24ebbcb24
No known key found for this signature in database
GPG Key ID: 7BAE94BC7141A594

23
roles/tox/README.rst Normal file
View File

@ -0,0 +1,23 @@
Runs tox for a project.
Role Variables
tox_environment
Environment variables to pass in to the tox run.
tox_environment_defaults
Default environment variables to pass in to the tox run. Intended to allow
setting a set of environment variables in a base job but to still allow
specific settings on a per-job or per-variant basis.
tox_envlist
Which tox environment to run. Defaults to 'venv'.
tox_executable
Location of the tox executable. Defaults to 'tox'.
tox_extra_args
String of extra command line options to pass to tox. Defaults to '-vv'.
zuul_work_dir
Directory to run tox in.