zuul-jobs/roles/tox/README.rst
Dirk Mueller df3a9882df Switch to TOX_CONSTRAINTS_FILE
This allows to use lower-constraints.txt more easily as input
when everyone has switched over.

Depends-On: https://review.opendev.org/660823

Change-Id: I3f957187ed4f29fcf88db99cb79fb33b21a8dd8d
2019-05-22 22:30:14 +02:00

40 lines
952 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
TOX_CONSTRAINTS_FILE (deprecated but currently still supported
name is 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.