zuul-jobs/roles/tox/README.rst
Monty Taylor d7cba9d7d5
Combine tox-siblings and tox roles
There is a bunch of duplicate logic between tox and tox-siblings, the
tox-siblings logic is already protected with a flag - and having them be
split already led to not doing the right thing with constraints files in
siblings when we did it right in tox itself.

Combine them into one role.

This means the siblings code will run as part of run instead of as part
of pre- but that's how things have worked for years anyway until
siblings was introduced - and is also the behavior is the siblings flag
is false -so it's more consistent overall.

Leave a no-op tox-siblings role so that we can gracefully remove the use of
tox-siblings from castellan, python-openstacksdk, shade and tacker.

Change-Id: Id61ae52d48b28cfc2221cb556a1c1f7c6dfd60dd
2017-11-29 15:34:08 -06:00

39 lines
877 B
ReStructuredText

Runs tox for a project
**Role Variables**
.. zuul:rolevar:: tox_environment
Environment variables to pass in to the tox run.
.. zuul:rolevar:: tox_envlist
:default: venv
Which tox environment to run.
.. zuul:rolevar:: tox_executable
:default: tox
Location of the tox executable.
.. zuul:rolevar:: tox_extra_args
:default: -vv
String of extra command line options to pass to tox.
.. zuul:rolevar:: tox_constraints_file
Path to a pip constraints file. Will be provided to tox via
UPPER_CONSTRAINTS_FILE environment variable if it exists.
.. zuul:rolevar:: tox_install_siblings
:default: true
Flag controlling whether to attempt to install python packages from any
other source code repos zuul has checked out. Defaults to True.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
Directory to run tox in.