diff options
| author | Miro Hrončok <miro@hroncok.cz> | 2021-03-03 12:19:39 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-03 11:19:39 +0000 |
| commit | 93a9667a8b84847294bc677c79bde8c70fe2f564 (patch) | |
| tree | aebf07c85aa359c1c60dbe4007ae03c5627c4cd6 /docs | |
| parent | a586b2a9d26c08e4dcdf4171ebae8079f5707e45 (diff) | |
| download | tox-git-93a9667a8b84847294bc677c79bde8c70fe2f564.tar.gz | |
Add --no-provision flag (#1922)
tox can now be invoked with a new --no-provision flag that prevents provision,
if requires or minversion are not satisfied, tox will fail;
if a path is specified as an argument to the flag
(e.g. as `tox --no-provision missing.json`) and provision is prevented,
provision metadata are written as JSON to that path.
Fixes https://github.com/tox-dev/tox/issues/1921
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog/1921.feature.rst | 6 | ||||
| -rw-r--r-- | docs/config.rst | 15 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/changelog/1921.feature.rst b/docs/changelog/1921.feature.rst new file mode 100644 index 00000000..64ea8c15 --- /dev/null +++ b/docs/changelog/1921.feature.rst @@ -0,0 +1,6 @@ +tox can now be invoked with a new ``--no-provision`` flag that prevents provision, +if :conf:`requires` or :conf:`minversion` are not satisfied, +tox will fail; +if a path is specified as an argument to the flag +(e.g. as ``tox --no-provision missing.json``) and provision is prevented, +provision metadata are written as JSON to that path - by :user:`hroncok` diff --git a/docs/config.rst b/docs/config.rst index 01bc9b7d..31e96331 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -38,6 +38,11 @@ Global settings are defined under the ``tox`` section as: than this the tool will create an environment and provision it with a version of tox that satisfies this under :conf:`provision_tox_env`. + .. versionchanged:: 3.23.0 + + When tox is invoked with the ``--no-provision`` flag, + the provision won't be attempted, tox will fail instead. + .. conf:: requires ^ LIST of PEP-508 .. versionadded:: 3.2.0 @@ -54,6 +59,11 @@ Global settings are defined under the ``tox`` section as: requires = tox-pipenv setuptools >= 30.0.0 + .. versionchanged:: 3.23.0 + + When tox is invoked with the ``--no-provision`` flag, + the provision won't be attempted, tox will fail instead. + .. conf:: provision_tox_env ^ string ^ .tox .. versionadded:: 3.8.0 @@ -61,6 +71,11 @@ Global settings are defined under the ``tox`` section as: Name of the virtual environment used to provision a tox having all dependencies specified inside :conf:`requires` and :conf:`minversion`. + .. versionchanged:: 3.23.0 + + When tox is invoked with the ``--no-provision`` flag, + the provision won't be attempted, tox will fail instead. + .. conf:: toxworkdir ^ PATH ^ {toxinidir}/.tox Directory for tox to generate its environments into, will be created if it does not exist. |