summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorPhil Dawson <phil.dawson@codethink.co.uk>2019-02-14 11:48:14 +0000
committerPhil Dawson <phildawson.0807@gmail.com>2019-02-20 15:14:42 +0000
commiteee9e2834079439ce451c64e4ae2dfbfe6d1fccb (patch)
treefcaea2048f757e7cfbd6514a3dd18ac3ed58be38 /CONTRIBUTING.rst
parent80a0832cf23950dd91a5cd233091af902e8754e8 (diff)
downloadbuildstream-eee9e2834079439ce451c64e4ae2dfbfe6d1fccb.tar.gz
tox.ini: Add 'venv' environment to run arbitrary commands in a venvphil/tox-vev-environment
This is a handy way for developers to make use of the venvs we're constructing for our test suite to run in.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 6a3fbf05f..c7ab1b8ab 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1589,6 +1589,15 @@ can run ``tox`` with ``-r`` or ``--recreate`` option.
./setup.py test --addopts 'tests/frontend/buildtrack.py::test_build_track'
+.. tip::
+
+ We also have an environment called 'venv' which takes any arguments
+ you give it and runs them inside the same virtualenv we use for our
+ tests::
+
+ tox -e venv -- <your command(s) here>
+
+ Any commands after ``--`` will be run a virtualenv managed by tox.
Observing coverage
~~~~~~~~~~~~~~~~~~