You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add ``__TOX_ENVIRONMENT_VARIABLE_ORIGINAL_CI``, which passes through the ``CI`` variable if present. This is intended for use by other libraries to detect if tox is running under CI.
Copy file name to clipboardExpand all lines: docs/config.rst
+39-9Lines changed: 39 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,8 @@ For example:
46
46
.. code-block:: ini
47
47
48
48
[tox]
49
-
min_version = 4.20
49
+
requires =
50
+
tox >= 4.20
50
51
env_list =
51
52
3.13
52
53
3.12
@@ -74,7 +75,8 @@ This configuration file uses:
74
75
.. code-block:: ini
75
76
76
77
[tox:tox]
77
-
min_version = 4.0
78
+
requires =
79
+
tox >= 4.0
78
80
env_list =
79
81
3.13
80
82
3.12
@@ -98,7 +100,8 @@ instead inside the ``pyproject.toml`` file under the ``tool.tox`` table and ``le
98
100
[tool.tox]
99
101
legacy_tox_ini = """
100
102
[tox]
101
-
min_version = 4.0
103
+
requires =
104
+
tox >= 4.0
102
105
env_list =
103
106
py310
104
107
py39
@@ -203,6 +206,9 @@ The following options are set in the ``[tox]`` section of ``tox.ini`` or the ``[
203
206
.. conf::
204
207
:keys: min_version, minversion
205
208
:default: <current version of tox>
209
+
:version_deprecated: 4.28.0
210
+
211
+
**DEPRECATED** Prefer requiring a minimum tox version via :ref:`requires`.
206
212
207
213
A string to define the minimal tox version required to run. If the host's tox version is less than this, it will
208
214
automatically create a provisioned tox environment that satisfies this requirement. See :ref:`provision_tox_env`
@@ -546,6 +552,16 @@ Base options
546
552
- ✅
547
553
- ✅
548
554
- ✅
555
+
* - SSH_AGENT_PID
556
+
- ✅
557
+
- ✅
558
+
- ❌
559
+
* - SSH_AUTH_SOCK
560
+
- ✅
561
+
- ✅
562
+
- ❌
563
+
564
+
If the environment variable ``CI`` is present, ``__TOX_ENVIRONMENT_VARIABLE_ORIGINAL_CI`` will be set to the value of ``CI``. The ``CI`` variable itself will not be passed through.
549
565
550
566
More environment variable-related information can be found in :ref:`environment variable substitutions`.
0 commit comments