Debian Codegraph @

docs/changelog.rst

raw
1 #################
2 Release History
3 #################
4
5 .. towncrier-draft-entries::
6
7 .. towncrier release notes start
8
9 **********************
10 v4.54.0 (2026-05-12)
11 **********************
12
13 Features - 4.54.0
14 =================
15
16 - Declare the runtime dependencies of the ``tox.pytest`` plugin (``pytest``, ``devpi-process`` and ``pytest-mock``)
17 under a new ``testing`` extra, so plugin authors can pull them in via ``tox[testing]`` - by :user:`gaborbernat`.
18 (:issue:`3938`, :issue:`3940`)
19
20 Bug fixes - 4.54.0
21 ==================
22
23 - Extend the generated TOML schema to cover every ``replace`` table form (``env``, ``ref``, ``posargs``, ``glob``,
24 ``if``), including conditional replacements used inside ``commands``. A guard test asserts the schema stays in sync
25 with the loader implementation so future replace types cannot be added without a corresponding schema entry.
26 (:issue:`3939`)
27
28 **********************
29 v4.53.1 (2026-05-02)
30 **********************
31
32 Bug fixes - 4.53.1
33 ==================
34
35 - Hardening pass on user-facing logging and config parsing:
36
37 - Mask secret-looking ``--key=value`` flag values in command logs (terminal warnings, ``.tox/<env>/log/*.log``, and
38 ``Outcome`` ``__repr__``) using the same keyword regex previously applied to environment variable values.
39 - Resolve PEP 723 ``script`` paths and reject any that escape ``tox_root``; cap the script read at 5 MiB so a symlink
40 to ``/dev/zero`` cannot exhaust memory.
41 - Replace ``eval()`` of a constructed ``Literal[...]`` string in the CLI parser with a direct
42 ``Literal[tuple(action.choices)]`` subscript.
43 - Pass ``timeout=30`` to ``urlopen`` when fetching a remote requirements file so a slow or unresponsive mirror cannot
44 hang ``tox`` indefinitely. (:issue:`3924`)
45
46 - Allow the generated TOML schema to validate array values for ``deps``. (:issue:`3929`)
47 - Correct type annotations for ``ArgumentParser.parse_args`` and ``parse_known_args`` overrides following `typeshed PR
48 #15613 <https://github.com/python/typeshed/pull/15613>`_, which widened the ``args`` parameter from ``Sequence[str]``
49 to ``Iterable[str]``. The narrower type in tox's overrides violated the Liskov substitution principle and caused
50 ``invalid-method-override`` errors with ``ty`` 0.0.33. Also correct the ``option_spec`` annotation in
51 ``docs/tox_conf.py`` to ``ClassVar[dict[str, Callable[[str], Any]]]`` matching the docutils stubs type.
52 (:issue:`3932`)
53
54 **********************
55 v4.53.0 (2026-04-14)
56 **********************
57
58 Features - 4.53.0
59 =================
60
61 - TOML ``env_list`` now accepts bare range dicts (``{ prefix = "3.", start = 12, stop = 14 }``) and bare labeled dicts
62 (``{ ecosystem = ["oci", "python"] }``) as top-level items, removing the ``{ product = [...] }`` wrapper when there is
63 only a single factor group - by :user:`gaborbernat`. (:issue:`3923`)
64
65 Bug fixes - 4.53.0
66 ==================
67
68 - Nesting a range or labeled dict inside a ``product`` factor-group list now raises a clear error pointing at the
69 un-nesting fix, instead of silently producing a malformed environment name - by :user:`gaborbernat`. (:issue:`3923`)
70
71 **********************
72 v4.52.1 (2026-04-09)
73 **********************
74
75 Bug fixes - 4.52.1
76 ==================
77
78 - Changing a resolution-affecting environment variable via ``set_env`` (e.g. ``PIP_INDEX_URL``) now invalidates the
79 install cache and triggers a reinstall, rather than incorrectly reusing the cached environment - by
80 :user:`gaborbernat`. (:issue:`3917`)
81 - Use ``normalize_isa`` from ``python-discovery`` for architecture factor matching, supporting aliases like ``i686`` →
82 ``x86`` and ``aarch64`` → ``arm64`` - by :user:`rahuldevikar`. (:issue:`3919`)
83
84 **********************
85 v4.52.0 (2026-03-30)
86 **********************
87
88 Features - 4.52.0
89 =================
90
91 - Add ``virtualenv-pep-723`` runner that reads dependencies and Python version from :PEP:`723` inline script metadata —
92 no need to duplicate them in tox config - by :user:`gaborbernat`. (:issue:`3897`)
93 - Support escaped dots (``\.``) in ``-x``/``--override`` keys, allowing overrides to target environments with dots in
94 their names such as ``py3.14`` - by :user:`gaborbernat`. (:issue:`3910`)
95
96 Bug fixes - 4.52.0
97 ==================
98
99 - Auto-generate the manpage from the CLI argparse parser at wheel build time, fixing broken section headers and
100 documenting all commands and options - by :user:`gaborbernat`. (:issue:`3878`)
101
102 Miscellaneous internal changes - 4.52.0
103 =======================================
104
105 - Remove unsupported ``--remote`` flag from ``gh repo fork`` in the update-schemastore workflow, as recent versions of
106 ``gh`` no longer accept it - by :user:`rahuldevikar`. (:issue:`3908`)
107
108 **********************
109 v4.51.0 (2026-03-27)
110 **********************
111
112 Features - 4.51.0
113 =================
114
115 - Add ``base_python_file`` configuration option to read the base Python version from a file (e.g. ``.python-version``),
116 similar to GitHub Actions' ``python-version-file`` - by :user:`rahuldevikar` (:issue:`3894`)
117
118 Bug fixes - 4.51.0
119 ==================
120
121 - Prevent implicit machine ISA (e.g. ``arm64``, ``x86_64``) from overriding explicit architecture factors in environment
122 names, fixing cross-architecture conflicts in multiline factor conditionals - by :user:`rahuldevikar`. (:issue:`3903`)
123 - Nested environment list configuration values are now properly parsed, validated and expanded by the TOML parser. This
124 allows you to use generative environment lists in ``tox-gh`` via the TOML format. Previously this was only possible
125 with the INI format. - by :user:`Daverball` (:issue:`3905`)
126
127 Miscellaneous internal changes - 4.51.0
128 =======================================
129
130 - Enable ``persist-credentials: true`` in the ``actions/checkout`` step of the prepare-release workflow so that git push
131 operations succeed during automated releases - by :user:`rahuldevikar`. (:issue:`3907`)
132
133 **********************
134 v4.50.3 (2026-03-20)
135 **********************
136
137 Bug fixes - 4.50.3
138 ==================
139
140 - Use separate ``.pkg`` environments for free-threaded Python targets by including the ``t`` suffix in the wheel build
141 environment name (e.g., ``.pkg-cpython314t``), preventing wheel tag mismatches when building for ``py314t`` - by
142 :user:`gaborbernat`. (:issue:`3314`)
143
144 **********************
145 v4.50.2 (2026-03-19)
146 **********************
147
148 Bug fixes - 4.50.2
149 ==================
150
151 - Fix the sdist to include the missing ``docs/man/tox.1.rst`` file for building the manpage (:issue:`3889`)
152
153 **********************
154 v4.50.1 (2026-03-19)
155 **********************
156
157 Bug fixes - 4.50.1
158 ==================
159
160 - Detect and suggest normalized environment names when users specify dotted Python versions (e.g., ``py3.10-lint``) that
161 match existing environments with compact notation (e.g., ``py310-lint``), preventing silent fallback to base
162 ``[testenv]`` configuration - by :user:`gaborbernat`. (:issue:`3877`)
163
164 **********************
165 v4.50.0 (2026-03-17)
166 **********************
167
168 Features - 4.50.0
169 =================
170
171 - Add ``interrupt_post_commands`` option to run cleanup commands even after SIGINT - by :user:`gaborbernat`.
172 (:issue:`3858`)
173 - Add ``factor['NAME']`` and ``env['VAR']`` subscript syntax for conditional expressions, enabling checks of factors
174 with non-identifier names like ``factor['3.14']``. Add ``env_name`` variable to check the full environment name in
175 conditions. (:issue:`3880`)
176
177 Bug fixes - 4.50.0
178 ==================
179
180 - Fix multiple manpage issues: remove duplicate header/author/copyright sections, set ``project`` in Sphinx config, and
181 compile the manpage to troff format at wheel-build time instead of shipping raw RST source - by :user:`gaborbernat`.
182 (:issue:`3878`)
183
184 Improved documentation - 4.50.0
185 ===============================
186
187 - Document how to reference the built package path in commands via ``TOX_PACKAGE`` - by :user:`rahuldevikar`
188 (:issue:`3862`)
189 - Fix broken TOML examples missing ``extend = true`` on conditional replacements inside lists, fix incorrect ``ref of``
190 path in raw reference docs, and add a test that validates all doc config examples - by :user:`gaborbernat`
191 (:issue:`3875`)
192
193 **********************
194 v4.49.1 (2026-03-09)
195 **********************
196
197 Bug fixes - 4.49.1
198 ==================
199
200 - Break deadlock in execution interrupt chain that caused ~18 flaky timeout failures across 9 tests on Windows/macOS CI
201 - by :user:`gaborbernat`. (:issue:`3869`)
202
203 **********************
204 v4.49.0 (2026-03-06)
205 **********************
206
207 Features - 4.49.0
208 =================
209
210 - Add ``{factor:label}`` substitution for TOML configs -- factor groups in ``product`` matrices and ``env_base`` factors
211 can now be labeled with single-key dicts (e.g., ``{ecosystem = ["oci", "python"]}``), enabling ``{factor:ecosystem}``
212 in any string value (descriptions, commands, etc.) to resolve to the active factor. Plain lists automatically get
213 positional labels (``{factor:0}``, ``{factor:1}``, ...) - by :user:`gaborbernat`. (:issue:`3860`) (:issue:`3860`)
214
215 Bug fixes - 4.49.0
216 ==================
217
218 - Fix ``--showconfig`` and ``--help-ini`` legacy flags raising ``AttributeError`` after config format options were added
219 - by :user:`rares985` (:issue:`3866`)
220
221 **********************
222 v4.48.1 (2026-03-06)
223 **********************
224
225 Bug fixes - 4.48.1
226 ==================
227
228 - Command-type configuration values like ``list_dependencies_command`` can now be referenced in TOML using the
229 structured ``{replace = "ref"}`` syntax. The reference automatically extracts the command's argument list for
230 compatibility with TOML's ``list[list[str]]`` structure - by :user:`gaborbernat`. (:issue:`3830`)
231
232 Improved documentation - 4.48.1
233 ===============================
234
235 - Replace archived ``31z4/tox`` Docker image recommendation with instructions for building your own image using the
236 official Python base image and ``uv`` - by :user:`rahuldevikar`. (:issue:`3855`)
237
238 **********************
239 v4.48.0 (2026-03-05)
240 **********************
241
242 Features - 4.48.0
243 =================
244
245 - Add ``--format`` flag (``ini``, ``json``, ``toml``) and ``-o``/``--output-file`` to the ``config`` command for
246 machine-readable output with native types. JSON and TOML use the same key structure as ``tox.toml`` (``env.<name>``
247 for environments, ``tox`` for core) and get syntax-highlighted on stdout - by :user:`gaborbernat`. (:issue:`3854`)
248
249 Improved documentation - 4.48.0
250 ===============================
251
252 - Add ``fail_fast`` to the configuration reference documentation - by :user:`rahuldevikar`. (:issue:`578`)
253
254 **********************
255 v4.47.3 (2026-03-04)
256 **********************
257
258 Bug fixes - 4.47.3
259 ==================
260
261 - ``ignore_base_python_conflict`` now also suppresses errors when an environment name contains multiple conflicting
262 version-like factors (e.g., ``unit-py3.10-2.16`` where both ``py3.10`` and ``2.16`` are detected as Python versions).
263 Previously this flag only handled conflicts between explicit ``base_python`` settings and the environment name - by
264 :user:`gaborbernat`. (:issue:`3850`)
265
266 **********************
267 v4.47.2 (2026-03-03)
268 **********************
269
270 Bug fixes - 4.47.2
271 ==================
272
273 - Handle ``OSError`` when checking if positional arguments are existing paths in ``pos_args()`` — long arguments (e.g.,
274 pytest ``-k`` expressions exceeding the 255-character filesystem name limit) no longer crash with ``OSError: [Errno
275 36] File name too long`` - by :user:`yarikoptic`. (:issue:`3847`)
276
277 **********************
278 v4.47.1 (2026-03-03)
279 **********************
280
281 Bug fixes - 4.47.1
282 ==================
283
284 - New-style version factors (e.g., ``3.10-tests``) now correctly set ``base_python`` - by :user:`gaborbernat`.
285 (:issue:`3845`)
286
287 **********************
288 v4.47.0 (2026-03-01)
289 **********************
290
291 Features - 4.47.0
292 =================
293
294 - Show clean error messages instead of stack traces when TOML configuration contains type mismatches (e.g., ``deps =
295 [1]``), wrapping failures in ``HandledError`` with environment and key context - by :user:`gaborbernat`.
296 (:issue:`3831`)
297 - Add comprehensive tests asserting full error messages for every configurable field type when TOML config contains type
298 mismatches - by :user:`gaborbernat`. (:issue:`3840`)
299
300 Bug fixes - 4.47.0
301 ==================
302
303 - Fix type errors flagged by ``ty`` for ``virtualenv`` API changes (``system_executable`` nullability and
304 ``cached_py_info.PythonInfo`` removal), and correct the CI workflow matrix exclude for ``windows-2025`` - by
305 :user:`gaborbernat`. (:issue:`3837`)
306 - ``base_python`` and ``default_base_python`` now accept a string value in TOML configuration (e.g., ``base_python =
307 "python"`` is coerced to ``["python"]``) instead of raising ``TypeError`` - by :user:`gaborbernat`. (:issue:`3839`)
308 - Pass stdin through to commands executed via ``tox exec`` so that piped input (e.g., ``echo "foo" | tox exec -- python
309 -c 'import sys; print(sys.stdin.read())'``) reaches the subprocess instead of being discarded - by
310 :user:`gaborbernat`. (:issue:`3841`)
311
312 **********************
313 v4.46.3 (2026-02-25)
314 **********************
315
316 Bug fixes - 4.46.3
317 ==================
318
319 - Fix SchemaStore update workflow creating PRs with merge conflicts by branching from upstream master - by
320 :user:`gaborbernat`. (:issue:`3828`)
321 - Fixed the minimum version of virtualenv, to avoid incompatibility. (:issue:`3829`)
322
323 **********************
324 v4.46.2 (2026-02-25)
325 **********************
326
327 Bug fixes - 4.46.2
328 ==================
329
330 - Fix SchemaStore update workflow authentication and PR creation for fork repositories - by :user:`gaborbernat`.
331 (:issue:`3826`)
332
333 **********************
334 v4.46.1 (2026-02-25)
335 **********************
336
337 Bug fixes - 4.46.1
338 ==================
339
340 - Allow glob patterns (``*``, ``?``) in ``depends`` configuration for ini files - by :user:`gaborbernat`.
341 (:issue:`3822`)
342 - Fix false positive schema validation errors with tombi by adding ``additionalProperties: true`` to
343 ``partial-tox.json`` on SchemaStore - by :user:`gaborbernat`. (:issue:`3823`)
344
345 **********************
346 v4.46.0 (2026-02-24)
347 **********************
348
349 Features - 4.46.0
350 =================
351
352 - Add architecture (ISA) awareness to Python discovery. tox now propagates the ``machine`` field (e.g. ``arm64``,
353 ``x86_64``) from :pypi:`virtualenv`'s interpreter info — derived from :func:`python:sysconfig.get_platform` — through
354 the Python specification, validation, and journal. This allows selecting a Python interpreter by CPU architecture via
355 :ref:`base_python` (e.g. ``cpython3.12-64-arm64``) and ensures tox validates the running interpreter's architecture
356 matches the requested one. Requires ``virtualenv >= 20.39`` - by :user:`rahuldevikar`. (:issue:`3069`)
357 - Add ``env_base`` TOML sections for named environment templates that generate multiple environments from factor
358 combinations via Cartesian product -- by :user:`gaborbernat`. (:issue:`3817`)
359
360 Bug fixes - 4.46.0
361 ==================
362
363 - Drop ``chardet`` dependency and use BOM detection with locale fallback for requirements file decoding, matching pip's
364 own approach - by :user:`gaborbernat`. (:issue:`3818`)
365 - Allow ``--help`` to render even when the configuration file is malformed or missing - by :user:`gaborbernat`.
366 (:issue:`3819`)
367
368 **********************
369 v4.45.0 (2026-02-23)
370 **********************
371
372 Features - 4.45.0
373 =================
374
375 - Enhance ``tox schema`` command: add ``x-taplo`` metadata for IDE integration, product dict support for ``env_list``,
376 handle ``int`` and ``PythonConstraints`` types, fix ``$schema`` draft-07 URI, and add schema freshness test. Add
377 ``tox.toml`` to SchemaStore catalog for automatic IDE validation - by :user:`gaborbernat`. (:issue:`1388`)
378
379 Bug fixes - 4.45.0
380 ==================
381
382 - Add redirects for old documentation URLs that broke after the Diataxis restructure (e.g. ``/config.html`` ->
383 ``/reference/config.html``, ``/example/general.html`` -> ``/index.html``) using ``sphinx-reredirects`` - by
384 :user:`gaborbernat`. (:issue:`3806`)
385 - Fix cross-section substitution ``{[section]key}`` resolving to a literal unresolved reference instead of empty string
386 when the referenced value contains only factor-conditional lines and no factors match the requesting environment - by
387 :user:`Fridayai700`. (:issue:`3809`)
388 - Fix circular dependency in ``environment_variables`` when ``set_env`` references ``{env_site_packages_dir}`` or
389 similar lazy constants, causing ``RecursionError`` silently caught as "could not find python interpreter" - by
390 :user:`gaborbernat`. (:issue:`3816`)
391
392 **********************
393 v4.44.0 (2026-02-20)
394 **********************
395
396 Features - 4.44.0
397 =================
398
399 - Support PEP 751 ``pylock.toml`` lock files as dependency input via the ``pylock`` configuration option (mutually
400 exclusive with ``deps``). Packages are filtered by extras, dependency groups, and platform markers evaluated against
401 the target Python interpreter, then installed via pip with ``--no-deps`` - by :user:`gaborbernat`. (:issue:`3665`)
402
403 Bug fixes - 4.44.0
404 ==================
405
406 - Fix unfactored continuation lines (e.g. ``pytest \``, ``--remote-data \``) being incorrectly skipped when they follow
407 a filtered factor-conditional line ending with ``\`` -- the ``pending_skip`` flag now only drops terminal continuation
408 pieces, preserving shared arguments that are themselves continuations - by :user:`gaborbernat`. (:issue:`3802`)
409
410 **********************
411 v4.43.0 (2026-02-20)
412 **********************
413
414 Features - 4.43.0
415 =================
416
417 - Add TOML-native generative ``env_list`` via ``product`` dict syntax -- Cartesian product of factor groups with
418 optional range dicts and exclusions - by :user:`gaborbernat`. (:issue:`3797`)
419
420 Bug fixes - 4.43.0
421 ==================
422
423 - Pass ``config_settings_build_wheel`` to pip as ``--config-settings`` when installing sdist packages, ensuring the
424 build backend receives config settings during pip's internal wheel build - by :user:`gaborbernat`. (:issue:`3125`)
425 - Fix factor-conditional continuation lines (e.g. ``cov: coverage run \`` / ``!cov: python \`` / ``somefile.py``) where
426 different factor prefixes on consecutive continuation lines caused prefixes to be passed as literal command arguments
427 instead of being filtered - by :user:`gaborbernat`. (:issue:`3796`)
428
429 Improved documentation - 4.43.0
430 ===============================
431
432 - Integrate ``sphinxcontrib-towncrier`` to render draft changelog entries directly in Sphinx, replacing the manual
433 towncrier draft script - by :user:`gaborbernat`. (:issue:`3201`)
434
435 **********************
436 v4.42.0 (2026-02-20)
437 **********************
438
439 Features - 4.42.0
440 =================
441
442 - Platform-dependent commands can now be specified using factor syntax without requiring the platform name in the
443 environment name. The current platform (``sys.platform`` value like ``linux``, ``darwin``, ``win32``) is automatically
444 available as an implicit factor, allowing configurations like ``linux: pytest`` in INI or ``factor.linux`` in TOML
445 conditional expressions to work in any environment. Additionally, TOML configurations can now use ``factor.NAME`` in
446 conditional expressions to filter settings based on environment name factors, achieving feature parity with INI's
447 factor system - by :user:`gaborbernat`. (:issue:`2092`)
448 - Add ``{env_site_packages_dir_plat}`` / ``{envsitepackagesdir_plat}`` substitution that returns the platform-specific
449 (platlib) site-packages directory. On some Linux distributions (Fedora, RHEL) this resolves to ``lib64`` instead of
450 ``lib``, which is no longer symlinked since virtualenv 20.x - by :user:`gaborbernat`. (:issue:`2302`)
451 - External packaging environments (``package = external``) now only run their build commands once per session, reusing
452 the built package for all test environments that depend on them - by :user:`gaborbernat`. (:issue:`2729`)
453 - Add ``default_base_python`` configuration key to specify a fallback Python interpreter when no Python factor or
454 explicit ``base_python`` is defined. This allows projects to pin a default Python version for reproducibility across
455 different machines without conflicting with ``pyXY`` factor-named environments - by :user:`gaborbernat`.
456 (:issue:`2846`)
457 - CLI options added by plugins listed in ``requires`` are now accepted during provisioning instead of failing with
458 "unrecognized arguments" - by :user:`gaborbernat`. (:issue:`2935`)
459 - Warn about unused configuration keys during ``tox run -v`` - by :user:`gaborbernat`. (:issue:`3188`)
460 - Improve towncrier changelog structure with more granular categories: ``breaking``, ``deprecation``, ``feature``,
461 ``bugfix``, ``doc``, ``packaging``, ``contrib``, and ``misc`` - by :user:`gaborbernat`. (:issue:`3200`)
462 - Add ``--skip-env-install`` CLI flag to skip dependency and package installation, allowing reuse of existing
463 environments when offline or when installation is unnecessary - by :user:`gaborbernat`. (:issue:`3310`)
464 - Add ``recreate_commands`` configuration option to run cleanup commands (e.g. clearing external caches like pre-commit)
465 before the environment directory is removed during recreation (``-r``) - by :user:`gaborbernat`. (:issue:`3423`)
466 - Environments with unavailable runners (missing plugins) are now gracefully skipped instead of causing a fatal error,
467 shown with status "NOT AVAILABLE". If such an environment is explicitly requested with ``-e``, a clear error message
468 is shown indicating which runner is missing and that the plugin may not be installed. Unavailable environments in the
469 configuration don't cause the overall run to fail - by :user:`gaborbernat`. (:issue:`3504`)
470 - Add open-ended range expansion in generative env lists — ``py3{9-}`` expands up to the latest supported CPython minor
471 version and ``py3{-13}`` expands down to the oldest supported one, both hardcoded at release time per the `Python
472 release cycle <https://devguide.python.org/versions/>`_ - by :user:`gaborbernat`. (:issue:`3583`)
473 - Add ``--no-capture`` (``-i``) CLI flag to disable output capture, allowing interactive programs like Python REPL to
474 access the terminal directly. When enabled, subprocess inherits parent console handles instead of pipes, fixing issues
475 where terminal APIs (e.g., querying console dimensions) fail on pipe handles. Mutually exclusive with
476 ``--result-json`` and parallel mode - by :user:`gaborjbernat`. Fixes :issue:`3635`. (:issue:`3635`)
477 - Add ``virtualenv_spec`` configuration key that allows pinning a specific virtualenv version per environment (e.g.
478 ``virtualenv_spec = "virtualenv<20.22.0"``). When set, tox bootstraps the specified version in an isolated environment
479 and drives it via subprocess, enabling environments targeting Python versions incompatible with the installed
480 virtualenv - by :user:`gaborbernat`. (:issue:`3656`)
481
482 Bug fixes - 4.42.0
483 ==================
484
485 - Suppress ``BrokenPipeError`` during backend teardown when interrupted, preventing traceback spam during
486 KeyboardInterrupt - by :user:`gaborjbernat`. Fixes :issue:`2660`. (:issue:`2660`)
487 - Factor-specific multiline commands using backslash continuation (``\``) no longer leak continuation lines into
488 environments that don't match the factor - by :user:`gaborbernat`. (:issue:`2912`)
489 - ``--list-dependencies`` output is now printed to stdout during parallel runs. Previously, the dependency list was
490 captured in suspended output buffers and only shown on failure - by :user:`gaborbernat`. (:issue:`3322`)
491 - Compound factor conditionals (e.g., ``np-cov: coverage``) now correctly allow their individual factors to be used when
492 specifying environments with ``-e``. Previously, running ``tox -e py310-np-cov`` with a factor conditional ``np-cov:
493 coverage`` in the config would fail with "provided environments not found" because the individual factor ``cov`` was
494 not recognized as combinable - by :user:`gaborbernat`. (:issue:`3780`)
495
496 Improved documentation - 4.42.0
497 ===============================
498
499 - Document Debian/Ubuntu ``python3-venv`` limitation in known limitations - by :user:`gaborbernat`. (:issue:`3195`)
500
501 **********************
502 v4.41.0 (2026-02-19)
503 **********************
504
505 Features - 4.41.0
506 =================
507
508 - Add ``package = "deps-only"`` mode that installs the package's dependencies (including extras) without building or
509 installing the package itself. For projects with static :PEP:`621` metadata, dependencies are read directly from
510 ``pyproject.toml`` without creating a packaging environment - by :user:`gaborbernat`. (:issue:`2301`)
511 - Prefer TOML-native configuration (``[tool.tox]``) over ``legacy_tox_ini`` when both are present in ``pyproject.toml``,
512 allowing users to include a ``legacy_tox_ini`` section with ``min_version`` for older tox versions while using native
513 TOML config for newer ones - by :user:`rahuldevikar`. (:issue:`3402`)
514
515 Bugfixes - 4.41.0
516 =================
517
518 - Fix PEP 517 backend crash detection to handle both ``ENOENT`` (missing interpreter) and runtime crashes without
519 hanging, and fix flaky ``test_provision_install_pkg_pep517`` integration test by using a pre-built wheel instead of an
520 sdist to avoid devpi mirror dependency on setuptools - by :user:`gaborjbernat`. (:issue:`3774`)
521
522 **********************
523 v4.40.0 (2026-02-19)
524 **********************
525
526 Features - 4.40.0
527 =================
528
529 - Add ``{glob:PATTERN}`` substitution to expand file system glob/wildcard patterns in configuration values. Supports
530 default values, recursive ``**`` matching, and both INI string syntax and TOML dict syntax (``{ replace = "glob",
531 pattern = "..." }``) - by :user:`gaborbernat`. (:issue:`1571`)
532 - Add ``commands_retry`` configuration option to automatically retry failed commands - by :user:`gaborbernat`.
533 (:issue:`1578`)
534 - Automatically create a ``.gitignore`` file containing ``*`` in the tox work directory (typically ``.tox/``) and in
535 environment info directories, so that tox-managed files are not tracked by git - by :user:`rahuldevikar`.
536 (:issue:`2530`)
537 - Add conditional value selection via ``replace = "if"`` in TOML configuration. Supports a ``condition`` expression with
538 ``env.VAR`` lookups, ``==``/``!=`` comparisons, and ``and``/``or``/``not`` boolean logic to select between ``then``
539 and ``else`` values - by :user:`gaborbernat`. (:issue:`3650`)
540 - Add ``sdist-wheel`` package type that builds a wheel from a source distribution, ensuring the sdist is complete and
541 the package can be correctly built from it — by :user:`rahuldevikar`. (:issue:`3687`)
542
543 Bugfixes - 4.40.0
544 =================
545
546 - Use positive exit code (``1``) instead of ``-1`` when reporting failures across multiple environments. On Windows,
547 ``cmd.exe``'s ``IF ERRORLEVEL 1`` only matches exit codes ``>= 1``, so the previous negative exit code was silently
548 treated as success - by :user:`radevika`. Fixes :issue:`2945`. (:issue:`2945`)
549 - When ``set_env`` both inherits via cross-section substitution (e.g., ``{[testenv]set_env}``) and explicitly overrides
550 the same variable, the explicit value was incorrectly replaced by the inherited one because ``load()`` moved the key
551 from the raw dict to the materialized dict before the deferred substitution ran, making the protection check
552 ineffective - by :user:`gaborjbernat`. Fixes :issue:`3773`. (:issue:`3773`)
553
554 **********************
555 v4.39.0 (2026-02-18)
556 **********************
557
558 Features - 4.39.0
559 =================
560
561 - Create a ``CACHEDIR.TAG`` file in the tox work directory (``.tox``) so that backup and archiving tools (e.g., ``tar
562 --exclude-caches``, Borg, restic) can automatically skip it - by :user:`radevika`. (:issue:`3334`)
563
564 Bugfixes - 4.39.0
565 =================
566
567 - On Windows, ANSI color codes from child processes (like pytest, mypy) are now rendered correctly in terminals by
568 enabling VT100 processing mode for subprocess output streams - by :user:`gaborbernat`. (:issue:`2337`)
569 - Concurrent tox processes no longer corrupt the provision environment (``.tox``) -- a file lock now serializes
570 provisioning across processes - by :user:`gaborbernat`. (:issue:`2515`)
571 - Config files (``tox.ini``, ``setup.cfg``) with unicode characters are now read correctly on Windows when running tox
572 with ``python -m -I`` (isolation mode) - by :user:`gaborbernat`. (:issue:`2692`)
573 - ``set_env`` values explicitly defined in a section now take precedence over values inherited via cross-section
574 substitution (e.g., ``{[testenv]set_env}``) - by :user:`gaborbernat`. (:issue:`2831`)
575 - The ``-e`` flag now supports brace expansion (e.g. ``tox -e 'py{38,39}-pytest{6.x,7.x}'``) instead of incorrectly
576 splitting on commas inside braces - by :user:`gaborbernat`. (:issue:`2850`)
577 - Posargs containing colons no longer crash tox when an inactive environment uses ``{posargs}`` in path-like
578 configuration values such as ``env_dir`` - by :user:`gaborbernat`. (:issue:`2860`)
579 - ``set_env`` values from cross-section substitution (e.g., ``{[testenv]set_env}``) now correctly override default
580 environment variables like ``PYTHONHASHSEED`` - by :user:`gaborbernat`. (:issue:`2872`)
581 - ``--force-dep`` now applies to package dependencies from project metadata (e.g. ``setup.cfg`` ``install_requires``,
582 ``pyproject.toml`` ``dependencies``), not just tox config ``deps`` - by :user:`gaborbernat`. (:issue:`2943`)
583 - Using ``{posargs}`` in ``change_dir`` no longer causes a ``RecursionError`` - by :user:`gaborbernat`. (:issue:`3062`)
584 - Cross-section substitution (e.g. ``{[testenv:a]commands}``) now resolves environment-specific variables like
585 ``{envpython}``, ``{envbindir}``, ``{envtmpdir}``, and ``{envsitepackagesdir}`` in the calling environment's context
586 rather than the referenced environment's context - by :user:`gaborbernat`. (:issue:`3075`)
587 - Fix ``ValueError`` crash when using posargs on Windows with ``subst`` drive mappings -- ``os.path.relpath`` fails
588 across drive letters, so fall back to absolute paths when the relative path cannot be computed - by
589 :user:`gaborbernat`. (:issue:`3086`)
590 - ``TOX_OVERRIDE`` with ``+=`` (append) now works correctly when the override key name differs from the config file key
591 name (e.g., overriding ``pass_env`` when config uses ``passenv``, or vice versa) - by :user:`gaborbernat`.
592 (:issue:`3127`)
593 - Fix spurious environment discovery from non-tox sections in ``setup.cfg`` -- ``packages = find:`` in ``[options]`` was
594 incorrectly interpreted as a tox factor marker, creating a phantom ``find`` environment - by :user:`gaborbernat`.
595 (:issue:`3134`)
596 - Requirements in ``requires`` with environment markers that evaluate to false (e.g. ``virtualenv<20.22.0;
597 python_version < "3.8"``) are now correctly skipped during provisioning instead of causing an infinite provisioning
598 loop - by :user:`gaborbernat`. (:issue:`3136`)
599 - Running environments with ``recreate = true`` no longer destroys shared package environments (e.g. ``.pkg``), which
600 previously caused ``FileNotFoundError`` when a subsequent environment tried to use the already-built wheel - by
601 :user:`gaborbernat`. (:issue:`3146`)
602 - Factor-conditional config values (e.g. ``base_python = py312: python3.12``) now correctly fall back to the default
603 when no factors match the current environment, instead of producing an empty value - by :user:`gaborbernat`.
604 (:issue:`3189`)
605 - ``TOX_PARALLEL_NO_SPINNER`` / ``--parallel-no-spinner`` no longer forces parallel mode in the legacy command, fixing
606 output suppression for sequential runs in CI - by :user:`gaborbernat`. (:issue:`3193`)
607 - Multiple ``-e`` flags are now additive (``tox r -e a -e b`` runs both ``a`` and ``b``), matching tox 3 behavior - by
608 :user:`gaborbernat`. (:issue:`3199`)
609 - Environments like ``functional-py312`` no longer incorrectly match when only ``functional{-py310}`` is defined as a
610 testenv section -- factors from section headers are no longer treated as freely combinable with CLI ``-e`` selections
611 - by :user:`gaborbernat`. (:issue:`3219`)
612 - On Windows, a trailing path separator (e.g. from ``{/}``) no longer causes the next command argument to be merged into
613 the path - backslash before whitespace is now treated as a literal path separator rather than a space escape - by
614 :user:`gaborbernat`. (:issue:`3222`)
615 - Fix ``{envtmpdir}`` and other env variable substitutions not expanding in external package environment commands - by
616 :user:`gaborbernat`. (:issue:`3238`) (:issue:`3238`)
617 - On Windows, colored output is now preserved when running provisioned tox by explicitly passing the ``--colored yes``
618 flag to the provisioned subprocess when the parent has colors enabled - by :user:`gaborbernat`. (:issue:`3331`)
619 - ``set_env`` values defined after a ``file|`` reference now correctly take precedence over values loaded from the env
620 file - by :user:`gaborbernat`. (:issue:`3335`)
621 - The ``base`` configuration key now works correctly in TOML format (``tox.toml`` and ``pyproject.toml``), allowing
622 environments to inherit from arbitrary sections defined under ``[env.*]`` - by :user:`gaborbernat`. (:issue:`3497`)
623 - Skip ``toxfile.py`` inline plugin when it uses hooks not available in the current tox version instead of crashing -
624 this allows provisioning to upgrade tox to a version that supports those hooks - by :user:`gaborbernat`.
625 (:issue:`3593`)
626 - ``set_env`` substitution referencing ``{envsitepackagesdir}``, ``{envbindir}``, or ``{envpython}`` for environments
627 with missing interpreters now raises ``Skip`` instead of ``RuntimeError``, allowing ``skip_missing_interpreters`` to
628 work correctly - by :user:`gaborbernat`. (:issue:`3597`)
629 - A ``setup.cfg`` without a ``[tox:tox]`` section no longer blocks discovery of ``pyproject.toml`` or ``tox.toml``
630 configuration files in the same directory - by :user:`gaborbernat`. (:issue:`3602`)
631 - Fix pytest ``INTERNALERROR`` on Python 3.15 caused by Pygments using deprecated ``os.path.commonprefix()`` - by
632 :user:`gaborbernat`. (:issue:`3733`)
633 - Fix ``RecursionError`` when TOML ``set_env`` contains substitutions like ``{env_site_packages_dir}`` that trigger
634 config loading cycles -- the TOML loader now defers string substitution in ``set_env`` values, matching the INI
635 loader's lazy resolution behavior - by :user:`gaborbernat`. (:issue:`3758`)
636
637 Documentation - 4.39.0
638 ======================
639
640 - Document that interactive terminal programs (e.g., IPython) may not work correctly under tox due to the PTY-based
641 output capture architecture - by :user:`gaborbernat`. (:issue:`2999`)
642
643 **********************
644 v4.38.0 (2026-02-17)
645 **********************
646
647 Features - 4.38.0
648 =================
649
650 - Scope dependency rejection in PEP-517 package environments to only pure PEP-517 build types (``sdist``, ``wheel``,
651 ``editable``), allowing non-standard package types like ``editable-legacy`` to specify dependencies - by
652 :user:`rahuldevikar`. (:issue:`3731`)
653
654 **********************
655 v4.37.0 (2026-02-17)
656 **********************
657
658 Features - 4.37.0
659 =================
660
661 - Add ``extra_setup_commands`` configuration option to run commands after dependency and package installation but before
662 test commands, useful with ``--notest`` for separating setup from execution - by :user:`gaborbernat`. (:issue:`1504`)
663
664 Bugfixes - 4.37.0
665 =================
666
667 - Set ``PIP_USER=0`` environment variable when running pip commands in virtualenvs to prevent pip from attempting
668 ``--user`` installs when users have ``pip config --user`` configured globally — by :user:`gaborbernat`.
669 (:issue:`3010`)
670 - Fix TOML env_run_base and env_pkg_base deps being clobbered when referenced with additional deps in testenv
671 configuration (:issue:`3393`)
672 - Normalize extra names when resolving dependencies so that underscores and hyphens are treated equivalently (e.g.
673 ``extras = snake_case`` now matches ``Provides-Extra: snake-case`` in wheel metadata) - by :user:`Fridayai700`.
674 (:issue:`3433`)
675 - Fix ``setenv`` modifications to ``PATH`` being overwritten when tox environment paths are set up - by
676 :user:`Fridayai700` (:issue:`3445`)
677 - Fix ``deps`` entries with ``~=`` version specifier being incorrectly treated as local paths instead of being passed
678 through to pip - by :user:`Fridayai700`. (:issue:`3447`)
679 - Fix factor selection via ``TOX_FACTORS`` environment variable producing wrong results because ``append`` +
680 ``nargs="+"`` actions need nested list types for proper env var conversion - by :user:`Fridayai700`. (:issue:`3557`)
681 - Fix custom ``install_command`` being ignored when specified in TOML configuration (``tox.toml``/``pyproject.toml``) -
682 by :user:`Fridayai700`. (:issue:`3574`)
683 - Fix env names containing dots (e.g. ``py3.11``) losing their description in TOML configuration - by
684 :user:`Fridayai700`. (:issue:`3590`)
685 - Run pre-commit on changelog.rst after towncrier build to ensure proper formatting before committing the release
686 (:issue:`3717`)
687 - Fix type checker CI failure by adding ``completion`` extras to ``type`` and ``type-min`` environments so ``ty`` can
688 resolve the ``argcomplete`` import - by :user:`gaborbernat`. (:issue:`3728`)
689
690 Documentation - 4.37.0
691 ======================
692
693 - Restructured documentation using the Diátaxis framework to separate Tutorial, How-to guides, Reference, and
694 Explanation content for better discoverability and user experience. (:issue:`3718`)
695
696 **********************
697 v4.36.1 (2026-02-17)
698 **********************
699
700 Bugfixes - 4.36.1
701 =================
702
703 - Report TOML parse errors during config discovery instead of silently ignoring them - by :user:`rahuldevikar`.
704 (:issue:`3030`)
705 - Adopt CPython's subprocess stream handling to fix deadlocks and improve performance when reading subprocess output
706 (:issue:`3715`)
707
708 Documentation - 4.36.1
709 ======================
710
711 - Add Unix man page generation and installation support using sphinx-argparse-cli - by :user:`gaborbernat`.
712 (:issue:`1409`)
713 - Document use of Python :mod:`logging` for plugin authors in the how-to guides, covering verbosity levels, coloring,
714 and best practices — by :user:`rahuldevikar`. (:issue:`3449`)
715 - Add architecture documentation for new contributors under the development section - by :user:`rahuldevikar`
716 (:issue:`3707`)
717
718 **********************
719 v4.36.0 (2026-02-15)
720 **********************
721
722 Features - 4.36.0
723 =================
724
725 - Allow ``skip_missing_interpreters`` to be set per environment, overriding the global setting. This enables marking
726 specific environments as optional while keeping others required. (:issue:`435`)
727 - Add ``--fail-fast`` CLI flag and ``fail_fast`` per-environment config option to stop executing remaining environments
728 when the first failure occurs - by :user:`gaborbernat`. (:issue:`578`)
729 - Add shell completion support for bash, zsh, and fish via :pypi:`argcomplete` - by :user:`gaborbernat` (:issue:`918`)
730 - Validate that configured extras exist in package metadata, raising a clear error for unknown extras - by
731 :user:`gaborbernat` (:issue:`1113`)
732 - Add glob pattern support in ``depends`` (e.g. ``depends = py3*``) to match environments by wildcard instead of listing
733 them explicitly - by :user:`gaborbernat` (:issue:`1152`)
734 - Add ``disallow_pass_env`` configuration option to exclude specific environment variables after ``pass_env`` glob
735 expansion - by :user:`gaborbernat` (:issue:`1387`)
736 - Support ``file:`` URIs in ``--installpkg`` (e.g. ``--installpkg file:///path/to/pkg.whl``), including proper handling
737 of percent-encoded characters - by :user:`rahuldevikar`. (:issue:`3498`)
738
739 Bugfixes - 4.36.0
740 =================
741
742 - Raise an error when ``deps`` is configured on a PEP-517 packaging environment (e.g. ``.pkg``), since build
743 dependencies should be specified via the ``[build-system]`` table in ``pyproject.toml`` - by :user:`rahuldevikar`
744 (:issue:`3412`)
745 - Follow `FORCE_COLOR <https://force-color.org/>`_ recommendations: any non-empty value now enables color (previously
746 only ``yes``, ``true``, or ``1`` were accepted, and other values caused a crash). Also add support for
747 ``TTY_COMPATIBLE`` (``1`` forces color, ``0`` disables it) — by :user:`rahuldevikar`. (:issue:`3579`)
748 - Return non-zero exit code from tox config when configuration exceptions occur. (:issue:`3649`)
749 - Fix flaky spinner test assertion caused by timing variations on slower systems. (:issue:`3692`)
750
751 Documentation - 4.36.0
752 ======================
753
754 - Document how to provide environments via ``toxfile.py`` inline plugins using ``tox_extend_envs`` and ``MemoryLoader``
755 - by :user:`gaborbernat`. (:issue:`828`)
756 - Document shell completion setup for bash, zsh, and fish in the CLI reference - by :user:`gaborbernat` (:issue:`918`)
757 - Document negative factor conditions and multi-factor combinations with negation in the INI configuration reference -
758 by :user:`gaborbernat` (:issue:`3276`)
759 - Add a substitution quick reference table covering all available ``{...}`` replacement variables - by
760 :user:`gaborbernat` (:issue:`3326`)
761 - Add TOML configuration reference with complete examples for ``tox.toml`` and ``pyproject.toml`` formats, and emphasize
762 TOML as the recommended format throughout - by :user:`gaborbernat` (:issue:`3393`)
763 - Document the ``tox exec`` subcommand with usage examples in the how-to guides - by :user:`gaborbernat` (:issue:`3403`)
764 - Comprehensive documentation improvements: added how-to guides for tox exec, CI/CD, coverage, build backends, labels,
765 migration, debugging, and extras; expanded plugin documentation with all hook examples and packaging guide; added env
766 var handling guide, factor conditions reference, and substitution quick reference; integrated docstrfmt for consistent
767 RST formatting; fixed docstring issues in source code - by :user:`gaborbernat` (:issue:`3475`)
768 - Update ``development.rst`` to reflect current standards: replace references to
769 ``flake8``/``black``/``isort``/``pyupgrade`` with ``ruff``, remove outdated Python 2.7 compatibility note, and fix CI
770 config filename - by :user:`rahuldevikar` (:issue:`3483`)
771 - Drop ``setup.py`` mentions from the installation page — by :user:`rahuldevikar`. (:issue:`3588`)
772 - Restructure documentation following the `Diataxis <https://diataxis.fr/>`_ framework: add a step-by-step tutorial
773 (``getting_started.rst``), consolidate how-to recipes (``howto.rst``), refocus the user guide on conceptual
774 explanation, and move plugin docs into their own ``plugins/`` subdirectory. Remove the obsolete tox 3-to-4 migration
775 guide (``upgrading.rst``) and FAQ, redistributing still-relevant content into the appropriate sections. All
776 configuration examples now show TOML first with INI alongside - by :user:`gaborbernat` (:issue:`3702`)
777
778 Miscellaneous - 4.36.0
779 ======================
780
781 - Switch type checker from ``mypy`` to ``ty`` - by :user:`gaborbernat`. (:issue:`3685`)
782 - Add GitHub Actions workflow dispatch for release preparation as alternative to local ``tox r -e release`` command - by
783 :user:`gaborbernat` (:issue:`3704`)
784
785 **********************
786 v4.35.0 (2026-02-12)
787 **********************
788
789 Features - 4.35.0
790 =================
791
792 - Show ``toxfile.py`` inline plugins in ``tox --version`` output, including any ``tox_append_version_info()`` result -
793 by :user:`rahuldevikar`. (:issue:`3508`)
794
795 Improved Documentation - 4.35.0
796 ===============================
797
798 - Document injected environment variables (``TOX_ENV_NAME``, ``TOX_WORK_DIR``, ``TOX_ENV_DIR``, ``TOX_PACKAGE``,
799 ``VIRTUAL_ENV``, ``PYTHONIOENCODING``, ``__TOX_ENVIRONMENT_VARIABLE_ORIGINAL_CI``) that tox automatically sets when
800 running commands - by :user:`rahuldevikar`. (:issue:`3514`)
801
802 **********************
803 v4.34.1 (2026-01-09)
804 **********************
805
806 Bugfixes - 4.34.1
807 =================
808
809 - Fix wheel corruption errors when the build backend updates the file in place - by :user:`gaborbernat`. (:issue:`3667`)
810
811 **********************
812 v4.34.0 (2026-01-08)
813 **********************
814
815 Features - 4.34.0
816 =================
817
818 - Support installing extras from the current project in dependency groups. -- by :user:`czaki`. (:issue:`3561`)
819
820 **********************
821 v4.33.0 (2026-01-02)
822 **********************
823
824 Features - 4.33.0
825 =================
826
827 - Add support for conditional ``set_env`` using PEP-496 environment markers. In INI format use ``VAR=value; marker``
828 syntax, in TOML format use ``set_env.VAR = { value = "...", marker = "..." }`` -- by :user:`gaborbernat`.
829 (:issue:`3663`)
830
831 Bugfixes - 4.33.0
832 =================
833
834 - Added 'LocalAppData' to the default passed environment variables on Windows. (:issue:`3639`)
835
836 Improved Documentation - 4.33.0
837 ===============================
838
839 - Sphinx is now set up to use :pypi:`sphinx-issues` for referencing GitHub issues and pull requests in the docs -- by
840 :user:`webknjaz`. (:issue:`3202`)
841
842 **********************
843 v4.32.0 (2025-10-24)
844 **********************
845
846 Bugfixes - 4.32.0
847 =================
848
849 - Expand braced range syntax in all internal sections of ``tox.ini`` (e.g. ``deps``, ``testenv``). Syntax like
850 py3{10-14} can be used in those sections now. - by :user:`marcosboger` (:issue:`3571`)
851
852 Improved Documentation - 4.32.0
853 ===============================
854
855 - Add Python 3.14 and 3.14t to config examples - by :user:`cclauss` (:issue:`3626`)
856
857 Misc - 4.32.0
858 =============
859
860 - :issue:`3629`
861
862 **********************
863 v4.31.0 (2025-10-09)
864 **********************
865
866 No significant changes.
867
868 **********************
869 v4.30.3 (2025-10-02)
870 **********************
871
872 Bugfixes - 4.30.3
873 =================
874
875 - Fix incorrect type annotation in ``PythonPathPackageWithDeps.__init__()`` where ``deps`` was annotated as
876 ``Sequence[Package]`` but should be ``Sequence[Requirement]`` to match actual runtime usage - by
877 :user:`PreistlyPython` (:issue:`3607`)
878 - Fix ``None`` appearing as the config filename in error output when the user's default config file is corrupt. - by
879 :user:`kurtmckee` (:issue:`3611`)
880
881 **********************
882 v4.30.2 (2025-09-04)
883 **********************
884
885 Bugfixes - 4.30.2
886 =================
887
888 - Previously, when tox ran in an automatically provisioned environment, it could hang waiting for a PEP 517 build
889 backend if used in conjunction with the ``--installpkg`` option. This has been fixed by properly tearing down the
890 automatically provisioned environment after the tests. - by :user:`vytas7` (:issue:`3600`)
891
892 **********************
893 v4.30.1 (2025-09-03)
894 **********************
895
896 Bugfixes - 4.30.1
897 =================
898
899 - Prevent tox from hanging upon exit due to orphaned build threads and subprocesses when the ``--installpkg`` option is
900 used with *sdist*. - by :user:`vytas7` (:issue:`3530`)
901
902 **********************
903 v4.30.0 (2025-09-03)
904 **********************
905
906 Features - 4.30.0
907 =================
908
909 - Add ``__TOX_ENVIRONMENT_VARIABLE_ORIGINAL_CI``, which passes through the ``CI`` variable if present. This is intended
910 for use by other libraries to detect if tox is running under CI. (:issue:`3442`)
911
912 Bugfixes - 4.30.0
913 =================
914
915 - Makes the error message more clear when pyproject.toml file cannot be loaded or is missing expected keys.
916 (:issue:`3578`)
917 - The :func:`tox_extend_envs() hook <tox.plugin.spec.tox_extend_envs>` recently added in :pr:`3591` turned out to not
918 work well with ``tox run``. It was fixed internally, not to exhaust the underlying iterator on the first use.
919
920 -- by :user:`webknjaz` (:issue:`3598`)
921
922 **********************
923 v4.29.0 (2025-08-29)
924 **********************
925
926 Features - 4.29.0
927 =================
928
929 - A new tox life cycle event is now exposed for use via :doc:`Plugins API </plugin/index>` -- by :user:`webknjaz`.
930
931 The corresponding hook point is :func:`tox_extend_envs <tox.plugin.spec.tox_extend_envs>`. It allows plugin authors to
932 declare ephemeral environments that they can then populate through the in-memory configuration loader interface.
933
934 This patch was made possible thanks to pair programming with :user:`gaborbernat` at PyCon US 2025. (:issue:`3510`,
935 :issue:`3591`)
936
937 **********************
938 v4.28.4 (2025-07-31)
939 **********************
940
941 Features - 4.28.4
942 =================
943
944 - Pass ssh-agent variables ``SSH_AGENT_PID`` and ``SSH_AUTH_SOCK`` in ``pass_env`` by default. - by :user:`daniilgankov`
945 (:issue:`3572`)
946
947 **********************
948 v4.28.3 (2025-07-25)
949 **********************
950
951 No significant changes.
952
953 **********************
954 v4.28.2 (2025-07-25)
955 **********************
956
957 Bugfixes - 4.28.2
958 =================
959
960 - Don't pass in the filter argument to tar.extractall on old Python versions - by :user:`gaborbernat`. (:issue:`3568`)
961
962 **********************
963 v4.28.1 (2025-07-22)
964 **********************
965
966 Bugfixes - 4.28.1
967 =================
968
969 - Use `tarfile.data_filter <https://docs.python.org/3/library/tarfile.html#tarfile.data_filter>`_ with ``extractall``
970 only on supported Python versions:
971
972 - ``>= 3.11.4``
973 - ``>= 3.10.12`` and ``< 3.11``
974 - ``>= 3.9.17`` and ``< 3.10``
975
976 by :user:`gaborbernat`. (:issue:`3565`)
977
978 **********************
979 v4.28.0 (2025-07-20)
980 **********************
981
982 Features - 4.28.0
983 =================
984
985 - Added ``constraints`` to allow specifying constraints files for all dependencies. (:issue:`3550`)
986 - Allow disabling tox plugins via the ``TOX_DISABLED_EXTERNAL_PLUGINS`` environment variable - by :user:`gaborbernat`.
987 (:issue:`3468`)
988
989 Improved Documentation - 4.28.0
990 ===============================
991
992 - The ``min_version``/``minversion`` config option is deprecated in favor of the ``requires`` option. (:issue:`3553`)
993
994 **********************
995 v4.27.0 (2025-06-17)
996 **********************
997
998 Features - 4.27.0
999 =================
1000
1001 - Add ``free_threaded`` flag to to ``"python"`` entries in json output of ``--result-json``. (:issue:`3534`)
1002
1003 Bugfixes - 4.27.0
1004 =================
1005
1006 - Fix dependency-group name normalization. (:issue:`3539`)
1007 - Improves logging of environment variables by sorting them by key and redacting the values for the ones that are likely
1008 to contain secrets. (:issue:`3542`)
1009
1010 **********************
1011 v4.26.0 (2025-05-13)
1012 **********************
1013
1014 Features - 4.26.0
1015 =================
1016
1017 - Add support for free-threaded python builds. Factors like ``py313t`` will only pick builds with the GIL disabled while
1018 factors without trailing ``t`` will only pick builds without no-GIL support. (:issue:`3391`)
1019 - Drop support for EOL Python 3.8. (:issue:`3527`)
1020
1021 Bugfixes - 4.26.0
1022 =================
1023
1024 - Fix a regression issue related to inability to use ``file|`` substitution option in nested ``set_env`` sections of
1025 ``ini`` configurations since tox4 update. (:issue:`2435`)
1026 - Fix ``TypeError`` for ``HelpFormatter`` with Python 3.14 (:issue:`3523`)
1027
1028 **********************
1029 v4.25.0 (2025-03-27)
1030 **********************
1031
1032 Features - 4.25.0
1033 =================
1034
1035 - Add support for number ranges in generative environments, more details :ref:`here <generative-environment-list>`. - by
1036 :user:`mimre25` (:issue:`3502`)
1037
1038 Bugfixes - 4.25.0
1039 =================
1040
1041 - Make tox tests pass with Python 3.14.0a6 - by :user:`hroncok` (:issue:`3500`)
1042
1043 **********************
1044 v4.24.2 (2025-03-07)
1045 **********************
1046
1047 Bugfixes - 4.24.2
1048 =================
1049
1050 - multiple source_type supports for the same filename. Like pyproject.toml can be load by both TomlPyProject &
1051 LegacyToml (:issue:`3117`)
1052 - Support ``set_env = { file = "conf{/}local.env"}`` for TOML format - by :user:`juditnovak`. (:issue:`3474`)
1053 - fix example on the docs (:issue:`3480`)
1054 - - ``--parallel-no-spinner`` now respects max CPU set by ``--parallel N`` (:issue:`3495`)
1055
1056 Improved Documentation - 4.24.2
1057 ===============================
1058
1059 - Updates the documentation for ``os.environ['KEY']`` when the variable does not exist - by :user:`jugmac00`.
1060 (:issue:`3456`)
1061
1062 **********************
1063 v4.24.1 (2025-01-21)
1064 **********************
1065
1066 Misc - 4.24.1
1067 =============
1068
1069 - :issue:`3426`
1070
1071 **********************
1072 v4.24.0 (2025-01-21)
1073 **********************
1074
1075 Features - 4.24.0
1076 =================
1077
1078 - Add a ``schema`` command to produce a JSON Schema for tox and the current plugins.
1079
1080 - by :user:`henryiii` (:issue:`3446`)
1081
1082 Bugfixes - 4.24.0
1083 =================
1084
1085 - Log exception name when subprocess execution produces one.
1086
1087 - by :user:`ssbarnea` (:issue:`3450`)
1088
1089 Improved Documentation - 4.24.0
1090 ===============================
1091
1092 - Fix typo in ``docs/config.rst`` from ``{}`` to ``{:}``.
1093
1094 - by :user:`wooshaun53` (:issue:`3424`)
1095
1096 - Pass ``NIX_LD`` and ``NIX_LD_LIBRARY_PATH`` variables by default in ``pass_env`` to make generic binaries work under
1097 Nix/NixOS.
1098
1099 - by :user:`albertodonato` (:issue:`3425`)
1100
1101 **********************
1102 v4.23.2 (2024-10-22)
1103 **********************
1104
1105 Misc - 4.23.2
1106 =============
1107
1108 - :issue:`3415`
1109
1110 **********************
1111 v4.23.1 (2024-10-21)
1112 **********************
1113
1114 Improved Documentation - 4.23.1
1115 ===============================
1116
1117 - Fix bad example in documentation for dependency groups - by :user:`gaborbernat`. (:issue:`3240`)
1118
1119 **********************
1120 v4.23.0 (2024-10-16)
1121 **********************
1122
1123 Features - 4.23.0
1124 =================
1125
1126 - Add ``NETRC`` to the list of environment variables always passed through. (:issue:`3410`)
1127
1128 Improved Documentation - 4.23.0
1129 ===============================
1130
1131 - replace ``[tool.pyproject]`` and ``[tool.tox.pyproject]`` with ``[tool.tox]`` in config.rst (:issue:`3411`)
1132
1133 **********************
1134 v4.22.0 (2024-10-15)
1135 **********************
1136
1137 Features - 4.22.0
1138 =================
1139
1140 - Implement dependency group support as defined in :PEP:`735` - see :ref:`dependency_groups` - by :user:`gaborbernat`.
1141 (:issue:`3408`)
1142
1143 **********************
1144 v4.21.2 (2024-10-03)
1145 **********************
1146
1147 Bugfixes - 4.21.2
1148 =================
1149
1150 - Include ``tox.toml`` in sdist archives to fix test failures resulting from its lack. - by :user:`mgorny`
1151 (:issue:`3389`)
1152
1153 **********************
1154 v4.21.1 (2024-10-02)
1155 **********************
1156
1157 Bugfixes - 4.21.1
1158 =================
1159
1160 - Fix error when using ``requires`` within a TOML configuration file - by :user:`gaborbernat`. (:issue:`3386`)
1161 - Fix error when using ``deps`` within a TOML configuration file - by :user:`gaborbernat`. (:issue:`3387`)
1162 - Multiple fixes for the TOML configuration by :user:`gaborbernat`.:
1163
1164 - Do not fail when there is an empty command within ``commands``.
1165 - Allow references for ``set_env`` by accepting list of dictionaries for it.
1166 - Do not try to be smart about reference unrolling, instead allow the user to control it via the ``extend`` flag,
1167 available both for ``posargs`` and ``ref`` replacements.
1168 - The ``ref`` replacements ``raw`` key has been renamed to ``of``. (:issue:`3388`)
1169
1170 **********************
1171 v4.21.0 (2024-09-30)
1172 **********************
1173
1174 Features - 4.21.0
1175 =================
1176
1177 - Native TOML configuration support - by :user:`gaborbernat`. (:issue:`999`)
1178
1179 Improved Documentation - 4.21.0
1180 ===============================
1181
1182 - Update Loader docs - by :user:ziima (:issue:`3352`)
1183
1184 **********************
1185 v4.20.0 (2024-09-18)
1186 **********************
1187
1188 Features - 4.20.0
1189 =================
1190
1191 - Separate the list dependencies functionality to a separate abstract class allowing code reuse in plugins (such as
1192 ``tox-uv``) - by :gaborbernat`. (:issue:`3347`)
1193
1194 **********************
1195 v4.19.0 (2024-09-17)
1196 **********************
1197
1198 Features - 4.19.0
1199 =================
1200
1201 - Support ``pypy-<major>.<minor>`` environment names for PyPy environments - by :user:`gaborbernat`. (:issue:`3346`)
1202
1203 **********************
1204 v4.18.1 (2024-09-07)
1205 **********************
1206
1207 Bugfixes - 4.18.1
1208 =================
1209
1210 - Fix and test the string spec for the ``sys.executable`` interpreter (introduced in :pr:`3325`) - by :user:`hroncok`
1211 (:issue:`3327`)
1212
1213 Improved Documentation - 4.18.1
1214 ===============================
1215
1216 - Changes the ``tox_env_teardown`` docstring to explain the hook is called after a tox env was teared down.
1217 (:issue:`3305`)
1218
1219 **********************
1220 v4.18.0 (2024-08-13)
1221 **********************
1222
1223 Features - 4.18.0
1224 =================
1225
1226 - Suppress spinner in parallel runs in CI - by :user:`ziima`. (:issue:`3318`)
1227
1228 Bugfixes - 4.18.0
1229 =================
1230
1231 - Boost temporary directories cleanup in tests - by :user:`ziima`. (:issue:`3278`)
1232 - Fix absolute base python paths conflicting - by :user:`gaborbernat`. (:issue:`3325`)
1233
1234 **********************
1235 v4.17.1 (2024-08-07)
1236 **********************
1237
1238 Bugfixes - 4.17.1
1239 =================
1240
1241 - Support for running ``-e <major>.<minor>`` has been lost, fixing it - by :user:`gaborbernat`. (:issue:`2849`)
1242 - ``base_python`` now accepts absolute paths to interpreter executable - by :user:`paveldikov`. (:issue:`3191`)
1243
1244 **********************
1245 v4.17.0 (2024-08-05)
1246 **********************
1247
1248 Features - 4.17.0
1249 =================
1250
1251 - Add ``graalpy`` prefix as a supported base python (:issue:`3312`)
1252 - Add :ref:`on_platform` core configuration holding the tox platform and do not install package when exec an environment
1253 - by :user:`gaborbernat`. (:issue:`3315`)
1254
1255 Bugfixes - 4.17.0
1256 =================
1257
1258 - Add table with default environment variables per OS (:issue:`2753`)
1259
1260 **********************
1261 v4.16.0 (2024-07-02)
1262 **********************
1263
1264 Bugfixes - 4.16.0
1265 =================
1266
1267 - - Add ``windir`` to the default list of Windows ``pass_env`` environment variables. - by :user:`kurtmckee`
1268 (:issue:`3302`)
1269
1270 Improved Documentation - 4.16.0
1271 ===============================
1272
1273 - - Fix typo in configuration example and fix broken link to code style guide. - by :user:`srenfo` (:issue:`3297`)
1274
1275 **********************
1276 v4.15.1 (2024-06-05)
1277 **********************
1278
1279 Features - 4.15.1
1280 =================
1281
1282 - Fix ``skip_missing_interpreters`` option for ``package = wheel`` (:issue:`3269`)
1283
1284 Bugfixes - 4.15.1
1285 =================
1286
1287 - Fix section substitution with setenv. (:issue:`3262`)
1288 - Allow ``ConfigSet.add_config`` to receive parameterized generics for ``of_type``. (:issue:`3288`)
1289
1290 **********************
1291 v4.15.0 (2024-04-26)
1292 **********************
1293
1294 Features - 4.15.0
1295 =================
1296
1297 - Add support for multiple appending override options (-x, --override) on command line - by :user:`amitschang`.
1298 (:issue:`3261`)
1299 - Add support for inverting exit code success criteria using bang (!) (:issue:`3271`)
1300
1301 Bugfixes - 4.15.0
1302 =================
1303
1304 - Fix issue that the leading character ``c`` was dropped from packages in constraints files - by :user:`jugmac00`.
1305 (:issue:`3247`)
1306 - Allow appending to ``deps`` with ``--override testenv.deps+=foo`` - by :user:`stefanor`. (:issue:`3256`)
1307 - Fix non-existing branch ``rewrite`` in the documentation to ``main``. (:issue:`3257`)
1308 - Update test typing for build 1.2.0, which has an explicit ``Distribution`` type - by :user:`stefanor`. (:issue:`3260`)
1309 - Fix broken input parsing for ``--discover`` flag. - by :user:`mimre25` (:issue:`3272`)
1310
1311 Improved Documentation - 4.15.0
1312 ===============================
1313
1314 - Rephrase ``--discover`` flag's description to avoid confusion between paths and executables. - by :user:`mimre25`
1315 (:issue:`3274`)
1316
1317 **********************
1318 v4.14.2 (2024-03-22)
1319 **********************
1320
1321 Bugfixes - 4.14.2
1322 =================
1323
1324 - Add provision arguments to ToxParser to fix crash when provisioning new tox environment without list-dependencies by
1325 :user:`seyidaniels` (:issue:`3190`)
1326
1327 Improved Documentation - 4.14.2
1328 ===============================
1329
1330 - Removed unused line from the ``fresh_subprocess`` documentation. (:issue:`3241`)
1331
1332 **********************
1333 v4.14.1 (2024-03-06)
1334 **********************
1335
1336 Bugfixes - 4.14.1
1337 =================
1338
1339 - Fix crash with fresh subprocess, if the build backend is setuptools automatically enable fresh subprocesses for build
1340 backend calls - by :user:`gaborbernat`. (:issue:`3235`)
1341
1342 **********************
1343 v4.14.0 (2024-03-05)
1344 **********************
1345
1346 Features - 4.14.0
1347 =================
1348
1349 - Support enabling fresh subprocess for packaging build backends via :ref:`fresh_subprocess` - by :user:`gaborbernat`.
1350 (:issue:`3227`)
1351 - Allow plugins attaching additional information to ``--version`` via ``tox_append_version_info`` method in the plugin
1352 module - by :user:`gaborbernat`. (:issue:`3234`)
1353
1354 **********************
1355 v4.13.0 (2024-02-16)
1356 **********************
1357
1358 Features - 4.13.0
1359 =================
1360
1361 - Extract virtual environment packaging code to its own base class not tied to ``virtualenv`` - by :user:`gaborbernat`.
1362 (:issue:`3221`)
1363
1364 Improved Documentation - 4.13.0
1365 ===============================
1366
1367 - Documented usage of ``pytest`` with ``tox run-parallel`` - by :user:`faph`. (:issue:`3187`)
1368 - Configuration: state in config directive sections their ini file sections - by :user:`0cjs`. (:issue:`3194`)
1369 - Development: summarize important points experienced developers need to know - by :user:`0cjs`. (:issue:`3197`)
1370
1371 **********************
1372 v4.12.1 (2024-01-16)
1373 **********************
1374
1375 Bugfixes - 4.12.1
1376 =================
1377
1378 - Fixed bug where running with --installpkg and multiple envs could not clean up between tests (:issue:`3165`)
1379
1380 **********************
1381 v4.12.0 (2024-01-11)
1382 **********************
1383
1384 Features - 4.12.0
1385 =================
1386
1387 - Always pass ``FORCE_COLOR`` and ``NO_COLOR`` to the environment (:issue:`3172`)
1388
1389 Bugfixes - 4.12.0
1390 =================
1391
1392 - ``--parallel-no-spinner`` flag now implies ``--parallel`` (:issue:`3158`)
1393
1394 Improved Documentation - 4.12.0
1395 ===============================
1396
1397 - -Fix ``open an issue`` link in development.rst (:issue:`3179`)
1398
1399 **********************
1400 v4.11.4 (2023-11-27)
1401 **********************
1402
1403 Bugfixes - 4.11.4
1404 =================
1405
1406 - Fix terminal size of tox subcommands (fixes ipython, ipdb, prompt_toolkit, ...). (:issue:`2999`)
1407 - Fix ``quickstart`` command from requiring ``root`` positional argument (:issue:`3084`)
1408 - Added 'AppData' to the default passed environment variables on Windows. (:issue:`3151`)
1409
1410 Improved Documentation - 4.11.4
1411 ===============================
1412
1413 - Fix default value for ``install_command`` - by :user:`hashar`. (:issue:`3126`)
1414 - Fix default value for ``base_python`` - by :user:`rpatterson`. (:issue:`3156`)
1415
1416 **********************
1417 v4.11.3 (2023-09-08)
1418 **********************
1419
1420 Bugfixes - 4.11.3
1421 =================
1422
1423 - Handle ``FileNotFoundError`` when the ``base_python`` interpreter doesn't exist (:issue:`3105`)
1424
1425 Improved Documentation - 4.11.3
1426 ===============================
1427
1428 - Explain how plugins are registered and discovered - by :user:`hashar`. (:issue:`3116`)
1429
1430 **********************
1431 v4.11.2 (2023-09-07)
1432 **********************
1433
1434 Bugfixes - 4.11.2
1435 =================
1436
1437 - Fix bug in ``config.rst`` by removing stray colons left over from (:issue:`3111`) - by :user:`posita`. (:issue:`3118`)
1438 - Provide example to make CLI help more helpful for ``-x``/``--override`` - by :user:`posita`. (:issue:`3119`)
1439
1440 Improved Documentation - 4.11.2
1441 ===============================
1442
1443 - Fix typos discovered by codespell - by :user:`cclauss`. (:issue:`3113`)
1444
1445 **********************
1446 v4.11.1 (2023-09-01)
1447 **********************
1448
1449 Bugfixes - 4.11.1
1450 =================
1451
1452 - Allow passing in multiple overrides using the ``;`` character and fix ``,`` being used as splitting values - by
1453 :user:`gaborbernat`. (:issue:`3112`)
1454
1455 **********************
1456 v4.11.0 (2023-08-29)
1457 **********************
1458
1459 Features - 4.11.0
1460 =================
1461
1462 - Add support for setting build backend ``config_settings`` in the configuration file - by :user:`gaborbernat`.
1463 (:issue:`3090`)
1464
1465 **********************
1466 v4.10.0 (2023-08-21)
1467 **********************
1468
1469 Features - 4.10.0
1470 =================
1471
1472 - Change accepted environment name rule: must be made up of factors defined in configuration or match regex
1473 ``(pypy|py|cython|)((\d(\.\d+(\.\d+)?)?)|\d+)?``. If an environment name does not match this fail, and if a close
1474 match found suggest that to the user. (:issue:`3099`)
1475
1476 Bugfixes - 4.10.0
1477 =================
1478
1479 - ``--override foo+=bar`` appending syntax will now work correctly when ``foo`` wasn't defined in ``tox.ini``.
1480 (:issue:`3100`)
1481
1482 *********************
1483 v4.9.0 (2023-08-16)
1484 *********************
1485
1486 Features - 4.9.0
1487 ================
1488
1489 - Disallow command line environments which are not explicitly specified in the config file - by :user:`tjsmart`.
1490 (:issue:`2858`)
1491
1492 *********************
1493 v4.8.0 (2023-08-12)
1494 *********************
1495
1496 Features - 4.8.0
1497 ================
1498
1499 - ``--override`` can now take options in the form of ``foo+=bar`` which will append ``bar`` to the end of an existing
1500 list/dict, rather than replacing it. (:issue:`3087`)
1501
1502 *********************
1503 v4.7.0 (2023-08-08)
1504 *********************
1505
1506 Features - 4.7.0
1507 ================
1508
1509 - Make ``--hashseed`` default to ``PYTHONHASHSEED``, if defined - by :user:`paravoid`. The main motivation for this is
1510 to able to set the hash seed when building the documentation with ``tox -e docs``, and thus avoid embedding a random
1511 value in the tox documentation for --help. This caused documentation builds to fail to build reproducibly.
1512 (:issue:`2942`)
1513
1514 Bugfixes - 4.7.0
1515 ================
1516
1517 - Update a regular expression in tests to match the exception message in both Python 3.12 and older. (:issue:`3065`)
1518
1519 Improved Documentation - 4.7.0
1520 ==============================
1521
1522 - Fix broken links - by :user:`gaborbernat`. (:issue:`3072`)
1523
1524 *********************
1525 v4.6.4 (2023-07-06)
1526 *********************
1527
1528 Bugfixes - 4.6.4
1529 ================
1530
1531 - Fix hang and zombie process on interrupt (CTRL-C). (:issue:`3056`)
1532
1533 *********************
1534 v4.6.3 (2023-06-19)
1535 *********************
1536
1537 Bugfixes - 4.6.3
1538 ================
1539
1540 - Ensure that ``get_requires_for_build_wheel`` is called before ``prepare_metadata_for_build_wheel``, and
1541 ``get_requires_for_build_editable`` is called before ``prepare_metadata_for_build_editable`` - by :user:`abravalheri`.
1542 (:issue:`3043`)
1543
1544 Improved Documentation - 4.6.3
1545 ==============================
1546
1547 - Linked environment variable substitutions docs in ``set_env`` and ``pass_env`` config docs. (:issue:`3039`)
1548
1549 *********************
1550 v4.6.2 (2023-06-16)
1551 *********************
1552
1553 Bugfixes - 4.6.2
1554 ================
1555
1556 - Avoid cache collision between editable wheel build and normal wheel build -- by :user:`f3flight`. (:issue:`3035`)
1557
1558 *********************
1559 v4.6.1 (2023-06-15)
1560 *********************
1561
1562 No significant changes.
1563
1564 *********************
1565 v4.6.0 (2023-06-05)
1566 *********************
1567
1568 Features - 4.6.0
1569 ================
1570
1571 - Added ``--list-dependencies`` and ``--no-list-dependencies`` CLI parameters. If unspecified, defaults to listing when
1572 in CI, but not otherwise. (:issue:`3024`)
1573
1574 Misc - 4.6.0
1575 ============
1576
1577 - :issue:`3020`
1578
1579 *********************
1580 v4.5.1 (2023-05-25)
1581 *********************
1582
1583 Bugfixes - 4.5.1
1584 ================
1585
1586 - Fix ``tox --devenv venv`` invocation without ``-e`` - by :user:`asottile`. (:issue:`2925`)
1587
1588 *********************
1589 v4.5.0 (2023-04-24)
1590 *********************
1591
1592 Features - 4.5.0
1593 ================
1594
1595 - When run with verbosity=1, the per-step timing summaries are suppressed at the end of the run. Thanks to
1596 :user:`nedbat` at the PyCon 2023 sprints. (:issue:`2891`)
1597
1598 Improved Documentation - 4.5.0
1599 ==============================
1600
1601 - Add FAQ entry on how to test EOL Python versions by :user:`jugmac00`. (:issue:`2989`)
1602
1603 **********************
1604 v4.4.12 (2023-04-13)
1605 **********************
1606
1607 Bugfixes - 4.4.12
1608 =================
1609
1610 - Avoid race conditions in tests using the ``demo_pkg_inline`` fixture. (:issue:`2985`)
1611
1612 **********************
1613 v4.4.11 (2023-04-05)
1614 **********************
1615
1616 Bugfixes - 4.4.11
1617 =================
1618
1619 - Fixed an issue where a tox plugin couldn't change the value of ``tox_root``. (:issue:`2966`)
1620
1621 **********************
1622 v4.4.10 (2023-04-05)
1623 **********************
1624
1625 Bugfixes - 4.4.10
1626 =================
1627
1628 - Fix issue where ``work_dir`` was not correctly including ``tox_root`` for test runs. (:issue:`2933`)
1629
1630 *********************
1631 v4.4.9 (2023-04-05)
1632 *********************
1633
1634 Bugfixes - 4.4.9
1635 ================
1636
1637 - Instead of raising ``UnicodeDecodeError`` when command output includes non-utf-8 bytes, ``tox`` will now use
1638 ``surrogateescape`` error handling to convert the unrecognized bytes to escape sequences according to :PEP:`383` - by
1639 :user:`masenf`. (:issue:`2969`)
1640
1641 Improved Documentation - 4.4.9
1642 ==============================
1643
1644 - Document running tox within a Docker container. (:issue:`1035`)
1645 - Added python version 3.11 to ``installation.rst``. (:issue:`2964`)
1646
1647 *********************
1648 v4.4.8 (2023-03-26)
1649 *********************
1650
1651 Bugfixes - 4.4.8
1652 ================
1653
1654 - ``tox.ini`` is now included in source distributions in order to make all tests pass. (:issue:`2939`)
1655 - Fix ``--index-url`` and ``--find-links`` being used together in ``requirements.txt`` files. (:issue:`2959`)
1656
1657 *********************
1658 v4.4.6 (2023-02-21)
1659 *********************
1660
1661 Bugfixes - 4.4.6
1662 ================
1663
1664 - Plugins are now able to access tox.ini config sections using a custom prefix with the same suffix / name as a tox
1665 ``testenv`` - by :user:`masenf` (:issue:`2926`)
1666
1667 *********************
1668 v4.4.5 (2023-02-07)
1669 *********************
1670
1671 Bugfixes - 4.4.5
1672 ================
1673
1674 - Ignore labels when tox will provision a runtime environment (``.tox``) so that environment configurations which depend
1675 on provisioned plugins or specific tox versions are not accessed in the outer tox process where the configuration
1676 would be invalid - by :user:`masenf`. (:issue:`2916`)
1677
1678 *********************
1679 v4.4.4 (2023-01-31)
1680 *********************
1681
1682 Bugfixes - 4.4.4
1683 ================
1684
1685 - Forward ``HOME`` by default - by :user:`gschaffner`. (:issue:`2702`)
1686
1687 *********************
1688 v4.4.3 (2023-01-30)
1689 *********************
1690
1691 Bugfixes - 4.4.3
1692 ================
1693
1694 - Tox will now expand self-referential extras discovered in package deps to respect local modifications to package
1695 metadata. This allows a package extra to explicitly depend on another package extra, which previously only worked with
1696 non-static metadata - by :user:`masenf`. (:issue:`2904`)
1697
1698 *********************
1699 v4.4.2 (2023-01-25)
1700 *********************
1701
1702 Bugfixes - 4.4.2
1703 ================
1704
1705 - Allow the user configuration file (default ``<appdir>/tox/config.ini``) to be overridden via the
1706 ``TOX_USER_CONFIG_FILE`` environment variable. Previously tox was looking at the ``TOX_CONFIG_FILE`` to override the
1707 user configuration, however that environment variable is already used to override the main configuration - by
1708 :user:`masenf`. (:issue:`2890`)
1709
1710 *********************
1711 v4.4.1 (2023-01-25)
1712 *********************
1713
1714 Bugfixes - 4.4.1
1715 ================
1716
1717 - In tox 4.4.0 ``constrain_package_deps`` was introduced with a default value of ``True``. This has been changed back to
1718 ``False``, which restores the original behavior of tox 4.3.5 - by :user:`masenf`. (:issue:`2897`)
1719
1720 *********************
1721 v4.4.0 (2023-01-25)
1722 *********************
1723
1724 Features - 4.4.0
1725 ================
1726
1727 - Test environments now recognize boolean config keys ``constrain_package_deps`` (default=true) and
1728 ``use_frozen_constraints`` (default=false), which control how tox generates and applies constraints files when
1729 performing ``install_package_deps``.
1730
1731 If ``constrain_package_deps`` is true (default), then tox will write out ``{env_dir}{/}constraints.txt`` and pass it
1732 to ``pip`` during ``install_package_deps``. If ``use_frozen_constraints`` is false (default), the constraints will be
1733 taken from the specifications listed under ``deps`` (and inside any requirements or constraints file referenced in
1734 ``deps``). Otherwise, ``list_dependencies_command`` (``pip freeze``) is used to enumerate exact package specifications
1735 which will be written to the constraints file.
1736
1737 In previous releases, conflicting package dependencies would silently override the ``deps`` named in the
1738 configuration, resulting in test runs against unexpected dependency versions, particularly when using tox factors to
1739 explicitly test with different versions of dependencies - by :user:`masenf`. (:issue:`2386`)
1740
1741 Bugfixes - 4.4.0
1742 ================
1743
1744 - When parsing command lines, use ``shlex(..., posix=True)``, even on windows platforms, since non-POSIX mode does not
1745 handle escape characters and quoting like a shell would. This improves cross-platform configurations without hacks or
1746 esoteric quoting.
1747
1748 To make this transition easier, on Windows, the backslash path separator will not treated as an escape character
1749 unless it precedes a quote, whitespace, or another backslash character. This allows paths to mostly be written in
1750 single or double backslash style.
1751
1752 Note that **double-backslash will no longer be escaped to a single backslash in substitutions**, instead the double
1753 backslash will be consumed as part of command splitting, on either posix or windows platforms.
1754
1755 In some instances superfluous double or single quote characters may be stripped from arg arrays in ways that do not
1756 occur in the default windows ``cmd.exe`` shell - by :user:`masenf`. (:issue:`2635`)
1757
1758 Improved Documentation - 4.4.0
1759 ==============================
1760
1761 - Add information when command from ``list_dependencies_command`` configuration option is used. (:issue:`2883`)
1762
1763 *********************
1764 v4.3.5 (2023-01-18)
1765 *********************
1766
1767 Bugfixes - 4.3.5
1768 ================
1769
1770 - When building a ``wheel`` or ``editable`` package with a PEP 517 backend, no longer pass an empty
1771 ``metadata_directory`` to the backend ``build_wheel`` or ``build_editable`` endpoint.
1772
1773 Some backends, such as PDM and poetry, will not generate package metadata in the presence of a ``metadata_directory``,
1774 even if it is empty.
1775
1776 Prior to this change, attempting to install a wheel created by tox using PDM or poetry would return an error like
1777 "There is no item named 'my-package.0.1.dist-info/WHEEL' in the archive" - by :user:`masenf`. (:issue:`2880`)
1778
1779 *********************
1780 v4.3.4 (2023-01-17)
1781 *********************
1782
1783 Bugfixes - 4.3.4
1784 ================
1785
1786 - When executing via the provisioning environment (``.tox`` by default), run ``tox`` in working directory of the parent
1787 process.
1788
1789 Prior to this change (from tox 4.0.0), the provisioned ``tox`` would execute with ``{tox_root}`` as the working
1790 directory, which breaks when a relative path is passed to ``-c`` or ``--conf`` and ``tox`` is executed in a working
1791 directory other than ``{tox_root}`` - by :user:`masenf`. (:issue:`2876`)
1792
1793 Misc - 4.3.4
1794 ============
1795
1796 - :issue:`2878`
1797
1798 *********************
1799 v4.3.3 (2023-01-16)
1800 *********************
1801
1802 Bugfixes - 4.3.3
1803 ================
1804
1805 - The provision environment (``.tox``) will never inherit from ``testenv``. During provisioning, other test environments
1806 are not processed, allowing the use of keys and values that may be registered by later tox version or provisioned
1807 plugins - by :user:`masenf`. (:issue:`2862`)
1808
1809 *********************
1810 v4.3.2 (2023-01-16)
1811 *********************
1812
1813 Bugfixes - 4.3.2
1814 ================
1815
1816 - Fix regression introduced in 4.3.0 which occurred when a substitution expression for an environment variable that had
1817 previously been substituted appears in the ini file after a substitution expression for a different environment
1818 variable. This situation erroneously resulted in an exception about "circular chain between set" of those variables -
1819 by :user:`masenf`. (:issue:`2869`)
1820
1821 *********************
1822 v4.3.1 (2023-01-15)
1823 *********************
1824
1825 Bugfixes - 4.3.1
1826 ================
1827
1828 - Fix regression introduced in 4.3.0 by expanding substitution expressions (``{...}``) that result from a previous
1829 subsitution's replacement value (up to 100 times). Note that recursive expansion is strictly depth-first; no
1830 replacement value will ever affect adjacent characters nor will expansion ever occur over the result of more than one
1831 replacement - by :user:`masenf`. (:issue:`2863`)
1832
1833 *********************
1834 v4.3.0 (2023-01-15)
1835 *********************
1836
1837 Features - 4.3.0
1838 ================
1839
1840 - Rewrite substitution replacement parser - by :user:`masenf`
1841
1842 - ``\`` acts as a proper escape for ``\`` in ini-style substitutions
1843 - The resulting value of a substitution is no longer reprocessed in the context of the broader string. (Prior to this
1844 change, ini-values were repeatedly re-substituted until the expression no longer had modifications)
1845 - Migrate and update "Substitutions" section of Configuration page from v3 docs.
1846 - ``find_replace_part`` is removed from ``tox.config.loader.ini.replace``
1847 - New names exported from ``tox.config.loader.ini.replace``:
1848 - ``find_replace_expr``
1849 - ``MatchArg``
1850 - ``MatchError``
1851 - ``MatchExpression``
1852 - Note: the API for ``replace`` itself is unchanged. (:issue:`2732`)
1853
1854 - Improved documentation for factors and test env names - by :user:`stephenfin`. (:issue:`2852`)
1855
1856 *********************
1857 v4.2.8 (2023-01-11)
1858 *********************
1859
1860 Bugfixes - 4.2.8
1861 ================
1862
1863 - Allow using package names with env markers for pip's ``--no-binary`` and ``--only-binary`` options - by :user:`q0w`.
1864 (:issue:`2814`)
1865
1866 *********************
1867 v4.2.7 (2023-01-11)
1868 *********************
1869
1870 Bugfixes - 4.2.7
1871 ================
1872
1873 - A testenv with multiple factors, one of which conflicts with a ``base_python`` setting in ``tox.ini``, will now use
1874 the correct Python interpreter version - by :user:`stephenfin`. (:issue:`2838`)
1875 - Explicitly list ``wheel`` as requirement for the tests, as some of the tests error without it. (:issue:`2843`)
1876 - tox has reverted support for Python factors that include PATCH release info (e.g. ``py3.10.1``), build architecture
1877 (e.g. ``pypy3-64``) or do not define a ``py`` prefix or other supported prefix (e.g. ``3.10``). These complex factors
1878 were initially supported with the release of tox 4.0 but has proven complicated to support. Instead, the simple
1879 factors supported by tox 3 e.g. (``py310``, ``pypy3``) or period-separated equivalent (``py3.10``) introduced in tox 4
1880 should be used. Users who wish to specify more specific Python version information should configure the
1881 :ref:`base_python` setting - by :user:`stephenfin`. (:issue:`2848`)
1882
1883 *********************
1884 v4.2.6 (2023-01-06)
1885 *********************
1886
1887 Bugfixes - 4.2.6
1888 ================
1889
1890 - Handle properly pip ``--no-binary`` / ``--only-binary`` options in requirements.txt format files. (:issue:`2814`)
1891
1892 *********************
1893 v4.2.5 (2023-01-06)
1894 *********************
1895
1896 Bugfixes - 4.2.5
1897 ================
1898
1899 - The combination of ``usedevelop = true`` and ``--skip-missing-interpreters=false`` will no longer fail for
1900 environments that were *not* invoked - by :user:`stephenfin`. (:issue:`2811`)
1901 - Fix an attribute error when ``use_develop = true`` is set and an unsupported interpreter version is requested - by
1902 :user:`stephenfin`. (:issue:`2826`)
1903 - tox returns a non-zero error code if all envs are skipped. It will now correctly do this if only a single env was
1904 requested and this was skipped - by :user:`stephenfin`. (:issue:`2827`)
1905
1906 *********************
1907 v4.2.4 (2023-01-05)
1908 *********************
1909
1910 Bugfixes - 4.2.4
1911 ================
1912
1913 - Setting ``[testenv] basepython = python3`` will no longer override the Python interpreter version requested by a
1914 factor, such as ``py311`` - by :user:`stephenfin`. (:issue:`2754`)
1915 - Also accept tab after colon before factor filter expansion - by :user:`pdecat`. (:issue:`2823`)
1916
1917 *********************
1918 v4.2.3 (2023-01-04)
1919 *********************
1920
1921 Bugfixes - 4.2.3
1922 ================
1923
1924 - ``devenv`` does not respect the specified path when the package is a wheel file - by :user:`gaborbernat`.
1925 (:issue:`2815`)
1926 - Require space after colon before factor filter expansion, unless it is the last character of the line - by
1927 :user:`pdecat`. (:issue:`2822`)
1928
1929 *********************
1930 v4.2.2 (2023-01-04)
1931 *********************
1932
1933 Bugfixes - 4.2.2
1934 ================
1935
1936 - Add ``CC``, ``CFLAGS``, ``CCSHARED``, ``CXX``, ``CPPFLAGS``, ``LDFLAGS``, ``PKG_CONFIG`` and
1937 ``PKG_CONFIG_SYSROOT_DIR`` to the default passed through environment variables list as these are needed for building
1938 various C-extensions - by :user:`gaborbernat`. (:issue:`2818`)
1939
1940 *********************
1941 v4.2.1 (2023-01-03)
1942 *********************
1943
1944 Bugfixes - 4.2.1
1945 ================
1946
1947 - Fix extracting extras from markers with more than 2 extras in an or chain - by :user:`dconathan`. (:issue:`2791`)
1948
1949 *********************
1950 v4.2.0 (2023-01-03)
1951 *********************
1952
1953 Features - 4.2.0
1954 ================
1955
1956 - Packaging environments now inherit from the ``pkgenv`` section, allowing to set all your packaging options in one
1957 place, and support the ``deps`` key to set additional dependencies that will be installed after ``pyproject.toml``
1958 static ``requires`` but before backends dynamic requires - by :user:`gaborbernat`. (:issue:`2543`)
1959
1960 Improved Documentation - 4.2.0
1961 ==============================
1962
1963 - Document breaking changes with tox 4 and packaging environments - by :user:`gaborbernat`. (:issue:`2543`)
1964 - Document how to handle environments whose names match ``tox`` subcommands - by :user:`sirosen`. (:issue:`2728`)
1965
1966 *********************
1967 v4.1.3 (2023-01-02)
1968 *********************
1969
1970 Bugfixes - 4.1.3
1971 ================
1972
1973 - Reuse package_env with ``--installpkg`` - by :user:`q0w`. (:issue:`2442`)
1974 - Fail more gracefully when pip :ref:`install_command` is empty - by :user:`jayaddison`. (:issue:`2695`)
1975
1976 Improved Documentation - 4.1.3
1977 ==============================
1978
1979 - Add breaking-change documentation for empty ``install_command`` values - by :user:`jayaddison`. (:issue:`2695`)
1980
1981 Misc - 4.1.3
1982 ============
1983
1984 - :issue:`2796`, :issue:`2797`
1985
1986 *********************
1987 v4.1.2 (2022-12-30)
1988 *********************
1989
1990 Bugfixes - 4.1.2
1991 ================
1992
1993 - Fix ``--skip-missing-interpreters`` behavior - by :user:`q0w`. (:issue:`2649`)
1994 - Restore tox 3 behavior of showing the output of pip freeze, however now only active when running inside a CI
1995 environment - by :user:`gaborbernat`. (:issue:`2685`)
1996 - Fix extracting extras from markers with many extras - by :user:`q0w`. (:issue:`2791`)
1997
1998 *********************
1999 v4.1.1 (2022-12-29)
2000 *********************
2001
2002 Bugfixes - 4.1.1
2003 ================
2004
2005 - Fix logging error with emoji in git branch name. (:issue:`2768`)
2006
2007 Improved Documentation - 4.1.1
2008 ==============================
2009
2010 - Add faq entry about reuse of environments - by :user:`jugmac00`. (:issue:`2788`)
2011
2012 *********************
2013 v4.1.0 (2022-12-29)
2014 *********************
2015
2016 Features - 4.1.0
2017 ================
2018
2019 - ``-f`` can be used multiple times and on hyphenated factors (e.g. ``-f py311-django -f py39``) - by :user:`sirosen`.
2020 (:issue:`2766`)
2021
2022 Improved Documentation - 4.1.0
2023 ==============================
2024
2025 - Fix a grammatical typo in docs/user_guide.rst. (:issue:`2787`)
2026
2027 **********************
2028 v4.0.19 (2022-12-28)
2029 **********************
2030
2031 Bugfixes - 4.0.19
2032 =================
2033
2034 - Create temp_dir if not exists - by :user:`q0w`. (:issue:`2770`)
2035
2036 **********************
2037 v4.0.18 (2022-12-26)
2038 **********************
2039
2040 Bugfixes - 4.0.18
2041 =================
2042
2043 - Strip leading and trailing whitespace when parsing elements in requirement files - by :user:`gaborbernat`.
2044 (:issue:`2773`)
2045
2046 **********************
2047 v4.0.17 (2022-12-25)
2048 **********************
2049
2050 Features - 4.0.17
2051 =================
2052
2053 - Suppress a report output when verbosity = 0. (:issue:`2697`)
2054
2055 Bugfixes - 4.0.17
2056 =================
2057
2058 - Fix ``--sdistonly`` behavior. (:issue:`2653`)
2059 - Override toxworkdir with --workdir. (:issue:`2654`)
2060
2061 **********************
2062 v4.0.16 (2022-12-20)
2063 **********************
2064
2065 Bugfixes - 4.0.16
2066 =================
2067
2068 - Fix :ref:`change_dir` is relative to current working directory rather than to the :ref:`tox_root` when using the
2069 ``-c`` argument to locate the ``tox.ini`` file - by :user:`gaborbernat`. (:issue:`2619`)
2070
2071 **********************
2072 v4.0.15 (2022-12-19)
2073 **********************
2074
2075 Bugfixes - 4.0.15
2076 =================
2077
2078 - Fix tox auto-provisioning not working and relax :ref:`min_version` default from ``4.0`` to no version constraint - by
2079 :user:`gaborbernat`. (:issue:`2634`)
2080 - Fix assertion in ``test_result_json_sequential`` when interpreter ``_base_executable`` is a hardlink (macOS homebrew)
2081 - by :user:`masenf`. (:issue:`2720`)
2082 - Complex negative factor filters not working - by :user:`gaborbernat`. (:issue:`2747`)
2083
2084 **********************
2085 v4.0.14 (2022-12-18)
2086 **********************
2087
2088 Bugfixes - 4.0.14
2089 =================
2090
2091 - Do not include non test environment sections or factor filters in INI configuration to factor discovery - by
2092 :user:`gaborbernat`. (:issue:`2746`)
2093
2094 **********************
2095 v4.0.13 (2022-12-17)
2096 **********************
2097
2098 Bugfixes - 4.0.13
2099 =================
2100
2101 - A plain section in INI configuration matching a tox environment name shadowed the laters configuration - by
2102 :user:`gaborbernat`. (:issue:`2636`)
2103 - Fix space not accepted in factor filter expression - by :user:`gaborbernat`. (:issue:`2718`)
2104
2105 **********************
2106 v4.0.12 (2022-12-16)
2107 **********************
2108
2109 Bugfixes - 4.0.12
2110 =================
2111
2112 - If tox is running in a tty, allocate a pty (pseudo terminal) for commands and copy termios attributes to show colors
2113 and improve interactive use - by :user:`masenf`. (:issue:`1773`)
2114 - Fix python hash seed not being set - by :user:`gaborbernat`. (:issue:`2645`)
2115 - Fix legacy CLI flags ``--pre``, ``--force-deps``, ``--sitepackages`` and ``--alwayscopy`` not working, and mark them
2116 as deprecated - by :user:`gaborbernat`. (:issue:`2690`)
2117
2118 Improved Documentation - 4.0.12
2119 ===============================
2120
2121 - Document user level config. (:issue:`2633`)
2122
2123 **********************
2124 v4.0.11 (2022-12-14)
2125 **********************
2126
2127 Features - 4.0.11
2128 =================
2129
2130 - Modified handling of ``NO_COLOR`` environment variable, consistent with `de facto conventions
2131 <https://no-color.org>`_: any non-empty string will enable ``NO_COLOR`` (disable colorized output); no ``NO_COLOR``
2132 variable or ``NO_COLOR`` with an empty string will disable ``NO_COLOR`` (enable colorized output) - by :user:`ptmcg`.
2133 (:issue:`2719`)
2134
2135 Bugfixes - 4.0.11
2136 =================
2137
2138 - ``TOX_SKIP_ENV`` environment variable now works again, and can also be set via the CLI argument ``--skip-env`` for any
2139 command where ``-e`` can be set - by :user:`mgedmin`. (:issue:`2698`)
2140 - ``tox config`` should only show :ref:`env_list` arguments by default instead of ``ALL`` - by :user:`gaborbernat`.
2141 (:issue:`2726`)
2142
2143 **********************
2144 v4.0.10 (2022-12-14)
2145 **********************
2146
2147 Features - 4.0.10
2148 =================
2149
2150 - Add ``py_dot_ver`` and ``py_impl`` constants to environments to show the current Python implementation and dot version
2151 (e.g. ``3.11``) for the current environment. These can be also used as substitutions in ``tox.ini`` - by
2152 :user:`gaborbernat`. (:issue:`2640`)
2153
2154 Bugfixes - 4.0.10
2155 =================
2156
2157 - ``--help`` now reports the default verbosity level (which is WARNING) correctly. (:issue:`2707`)
2158
2159 *********************
2160 v4.0.9 (2022-12-13)
2161 *********************
2162
2163 Features - 4.0.9
2164 ================
2165
2166 - Add :meth:`tox_on_install <tox.plugin.spec.tox_on_install>` and :meth:`tox_env_teardown
2167 <tox.plugin.spec.tox_env_teardown>` plugin hooks - by :user:`gaborbernat`. (:issue:`2687`)
2168 - Add ``PKG_CONFIG_PATH`` to the default pass through environment list for python tox environments - by
2169 :user:`gaborbernat`. (:issue:`2700`)
2170
2171 *********************
2172 v4.0.8 (2022-12-11)
2173 *********************
2174
2175 Bugfixes - 4.0.8
2176 ================
2177
2178 - Fix multiple substitution on factor filtering in ``tox.ini`` when multiple factor filters match - by
2179 :user:`gaborbernat`. (:issue:`2650`)
2180 - Fix regression in ``requirements.txt`` parsing - by :user:`gaborbernat`. (:issue:`2682`)
2181
2182 *********************
2183 v4.0.7 (2022-12-11)
2184 *********************
2185
2186 Bugfixes - 4.0.7
2187 ================
2188
2189 - Support for ``--no-deps`` flag within the :ref:`deps` - by :user:`gaborbernat`. (:issue:`2674`)
2190
2191 *********************
2192 v4.0.6 (2022-12-10)
2193 *********************
2194
2195 Features - 4.0.6
2196 ================
2197
2198 - Fail on :ref:`pass_env`/:ref:`passenv` entries containing whitespace - by :user:`ericzolf`. (:issue:`2658`)
2199
2200 *********************
2201 v4.0.5 (2022-12-09)
2202 *********************
2203
2204 Bugfixes - 4.0.5
2205 ================
2206
2207 - Normalize extra names passed in (fixes extra groups not being picked up during installation) - by :user:`gaborbernat`.
2208 (:issue:`2655`)
2209
2210 *********************
2211 v4.0.4 (2022-12-09)
2212 *********************
2213
2214 Bugfixes - 4.0.4
2215 ================
2216
2217 - Disable logging from ``distlib.util`` and ``filelock`` as these log messages are too verbose - by :user:`gaborbernat`.
2218 (:issue:`2655`)
2219 - Use ``!r`` and ``repr()`` to better display erroneous values in exception from ``StrConverter.to_bool()`` - by
2220 :user:`ptmcg`. (:issue:`2665`)
2221
2222 Improved Documentation - 4.0.4
2223 ==============================
2224
2225 - Document that running ``--showconfig`` or ``--help-ini`` with the ``-v`` flag will add interleaved debugging
2226 information, whereas tox v3 added extra lines at the start - by :user:`jugmac00`. (:issue:`2622`)
2227 - Document that tox v4 errors when using ``-U`` when defining dependencies via ``deps`` - by :user:`jugmac00`.
2228 (:issue:`2631`)
2229
2230 *********************
2231 v4.0.3 (2022-12-08)
2232 *********************
2233
2234 Bugfixes - 4.0.3
2235 ================
2236
2237 - Always set environment variable ``PYTHONIOENCODING`` to ``utf-8`` to ensure tox works under Windows custom encodings -
2238 by :user:`gaborbernat`. (:issue:`2422`)
2239 - Ensure :ref:`change_dir` is created if does not exist before executing :ref:`commands` - by :user:`gaborbernat`.
2240 (:issue:`2620`)
2241 - Pass through ``NUMBER_OF_PROCESSORS`` on Windows as is needed for ``multiprocessing.cpu_count`` - by
2242 :user:`gaborbernat`. (:issue:`2629`)
2243 - The core tox configuration now contains ``host_python`` key showing the host python executable path - by
2244 :user:`gaborbernat`. (:issue:`2630`)
2245
2246 Improved Documentation - 4.0.3
2247 ==============================
2248
2249 - Document that space separator is no longer valid for the :ref:`passenv` and instead one should use comma - by
2250 :user:`gaborbernat`. (:issue:`2615`)
2251 - Document necessity to escape ``#`` within INI configuration - by :user:`jugmac00`. (:issue:`2617`)
2252
2253 *********************
2254 v4.0.2 (2022-12-07)
2255 *********************
2256
2257 Bugfixes - 4.0.2
2258 ================
2259
2260 - Unescaped comma in substitution should not be replaced during INI expansion - by :user:`gaborbernat`. (:issue:`2616`)
2261 - ``tox --showconfig -e py311`` reports tox section, though it should not - by :user:`gaborbernat`. (:issue:`2624`)
2262
2263 *********************
2264 v4.0.1 (2022-12-07)
2265 *********************
2266
2267 Bugfixes - 4.0.1
2268 ================
2269
2270 - Create session views of the build wheel/sdist into the :ref:`temp_dir` folder - by :user:`gaborbernat`.
2271 (:issue:`2612`)
2272 - Default tox min_version to 4.0 instead of current tox version - by :user:`gaborbernat`. (:issue:`2613`)
2273
2274 *********************
2275 v4.0.0 (2022-12-07)
2276 *********************
2277
2278 Bugfixes - 4.0.0
2279 ================
2280
2281 - The temporary folder within the tox environment was named ``.temp`` instead of ``.tmp`` - by :user:`gaborbernat`.
2282 (:issue:`2608`)
2283
2284 Improved Documentation - 4.0.0
2285 ==============================
2286
2287 - Enumerate breaking changes of tox 4 in the FAQ, and also list major new improvements - by :user:`gaborbernat`.
2288 (:issue:`2587`)
2289 - Document in the FAQ that tox 4 will raise a warning when finding conflicting environment names - by
2290 :user:`gaborbernat`. (:issue:`2602`)
2291
2292 ************************
2293 v4.0.0rc4 (2022-12-06)
2294 ************************
2295
2296 Bugfixes - 4.0.0rc4
2297 ===================
2298
2299 - Fix extras not being kept for install dependencies - by :user:`gaborbernat`. (:issue:`2603`)
2300
2301 Deprecations and Removals - 4.0.0rc4
2302 ====================================
2303
2304 - Remove deprecated configuration option ``whitelist_externals`` which was replaced by ``allowlist_externals`` - by
2305 :user:`jugmac00`. (:issue:`2599`)
2306
2307 ************************
2308 v4.0.0rc3 (2022-12-05)
2309 ************************
2310
2311 Features - 4.0.0rc3
2312 ===================
2313
2314 - Add ``--exit-and-dump-after`` flag that allows automatically killing tox if does not finish within the passed seconds,
2315 and dump the thread stacks (useful to debug tox when it seemingly hangs) - by :user:`gaborbernat`. (:issue:`2595`)
2316
2317 Bugfixes - 4.0.0rc3
2318 ===================
2319
2320 - Ensure that two parallel tox instance invocations on different tox environment targets will work by holding a file
2321 lock onto the packaging operations (e.g., in bash ``tox4 r -e py311 &; tox4 r -e py310``) - by :user:`gaborbernat`.
2322 (:issue:`2594`)
2323 - Fix leaking backend processes when the build backend does not support editable wheels and fix failure when multiple
2324 environments exist that have a build backend that does not support editable wheels - by :user:`gaborbernat`.
2325 (:issue:`2595`)
2326
2327 ************************
2328 v4.0.0rc2 (2022-12-04)
2329 ************************
2330
2331 Features - 4.0.0rc2
2332 ===================
2333
2334 - Support for recursive extras in Python package dependencies - by :user:`gaborbernat`. (:issue:`2567`)
2335
2336 Bugfixes - 4.0.0rc2
2337 ===================
2338
2339 - Support in INI files for ignore exit code marker the ``-`` without a subsequent space too - by :user:`gaborbernat`.
2340 (:issue:`2561`)
2341 - Ensure paths constructed by tox are stable by resolving relative paths to fully qualified one, this insures that
2342 running tox from a different folder than project root still generates meaningful paths - by :user:`gaborbernat`.
2343 (:issue:`2562`)
2344 - Ensure only on run environment operates at a time on a packaging environment (fixes unexpected failures when running
2345 in parallel mode) - by :user:`gaborbernat`. (:issue:`2564`)
2346 - Fallback to ``editable-legacy`` if package target is ``editable`` but the build backend does not have
2347 ``build_editable`` hook - by :user:`gaborbernat`. (:issue:`2567`)
2348 - Allow reference replacement in INI configuration via keys that contain the ``-`` character - by :user:`gaborbernat`.
2349 (:issue:`2569`)
2350 - Resolve symlinks when saving Python executable path - by :user:`ssbarnea`. (:issue:`2574`)
2351 - Do not set ``COLUMNS`` or ``LINES`` environment to the current TTY size if already set by the user - by
2352 :user:`gaborbernat`. (:issue:`2575`)
2353 - Add missing :pypi:`build[virtualenv]<build>` test dependency - by :user:`ssbarnea`. (:issue:`2576`)
2354
2355 ************************
2356 v4.0.0rc1 (2022-11-29)
2357 ************************
2358
2359 Features - 4.0.0rc1
2360 ===================
2361
2362 - Add support for generative section headers - by :user:`gaborbernat`. (:issue:`2362`)
2363
2364 Bugfixes - 4.0.0rc1
2365 ===================
2366
2367 - Allow installing relative paths that go outside tox root folder. - by :user:`ssbarnea`. (:issue:`2366`)
2368
2369 ***********************
2370 v4.0.0b3 (2022-11-27)
2371 ***********************
2372
2373 Features - 4.0.0b3
2374 ==================
2375
2376 - Improve coloring of logged commands - by :user:`ssbarnea`. (:issue:`2356`)
2377 - Pass ``PROGRAMDATA``, ``PROGRAMFILES(x86)``, ``PROGRAMFILES`` environments on Windows by default as it is needed for
2378 discovering the VS C++ compiler and start testing against 3.11 - by :user:`gaborbernat`. (:issue:`2492`)
2379 - Support PEP-621 static metadata for getting package dependencies - by :user:`gaborbernat`. (:issue:`2499`)
2380 - Add support for editable wheels, make it the default development mode and rename ``dev-legacy`` mode to
2381 ``editable-legacy`` - by :user:`gaborbernat`. (:issue:`2502`)
2382
2383 Bugfixes - 4.0.0b3
2384 ==================
2385
2386 - Recognize ``TERM=dumb`` or ``NO_COLOR`` environment variables. - by :user:`ssbarnea`. (:issue:`1290`)
2387 - Allow passing config directory without filename. - by :user:`ssbarnea`. (:issue:`2340`)
2388 - Avoid ignored explicit argument 're' console message. - by :user:`ssbarnea`. (:issue:`2342`)
2389 - Display registered plugins with ``tox --version`` - by :user:`mxd4`. (:issue:`2358`)
2390 - Allow ``--hash`` to be specified in requirements.txt files. - by :user:`masenf`. (:issue:`2373`)
2391 - Avoid impossible minversion version requirements. - by :user:`ssbarnea`. (:issue:`2414`)
2392
2393 Improved Documentation - 4.0.0b3
2394 ================================
2395
2396 - Add new documentation for tox 4 - by :user:`gaborbernat`. (:issue:`2408`)
2397
2398 ***********************
2399 v4.0.0b2 (2022-04-11)
2400 ***********************
2401
2402 Features - 4.0.0b2
2403 ==================
2404
2405 - Use ``tox`` console entry point name instead of ``tox4`` - by :user:`gaborbernat`. (:issue:`2344`)
2406 - Use ``.tox`` as working directory instead of ``.tox/4`` - by :user:`gaborbernat`. (:issue:`2346`)
2407 - Switch to ``hatchling`` as build backend instead of ``setuptools`` - by :user:`gaborbernat`. (:issue:`2368`)
2408
2409 Bugfixes - 4.0.0b2
2410 ==================
2411
2412 - Fix CLI raises an error for ``-va`` with ``ignored explicit argument 'a'`` - by :user:`gaborbernat`. (:issue:`2343`)
2413 - Do not interpolate values when parsing ``tox.ini`` configuration files - by :user:`gaborbernat`. (:issue:`2350`)
2414
2415 Improved Documentation - 4.0.0b2
2416 ================================
2417
2418 - Deleted the tox mailing list -- by :user:`jugmac00` (:issue:`2364`)
2419
2420 ***********************
2421 v4.0.0b1 (2022-02-05)
2422 ***********************
2423
2424 Features - 4.0.0b1
2425 ==================
2426
2427 - Display a hint for unrecognized argument CLI parse failures to use ``--`` separator to pass arguments to commands - by
2428 :user:`gaborbernat`. (:issue:`2183`)
2429 - Do not allow extending the config set beyond setup to ensures that all configuration values are visible via the config
2430 sub-command. - by :user:`gaborbernat`. (:issue:`2243`)
2431 - Print a message when ignoring outcome of commands - by :user:`gaborbernat`. (:issue:`2315`)
2432
2433 Bugfixes - 4.0.0b1
2434 ==================
2435
2436 - Fix type annotation is broken for :meth:`tox.config.sets.ConfigSet.add_config` when adding a container type - by
2437 :user:`gaborbernat`. (:issue:`2233`)
2438 - Insert ``TOX_WORK_DIR``, ``TOX_ENV_NAME``, ``TOX_ENV_DIR`` and ``VIRTUAL_ENV`` into the environment variables for all
2439 tox environments to keep contract with tox version 3 - by :user:`gaborbernat`. (:issue:`2259`)
2440 - Fix plugin initialization order - core plugins first, then 3rd party and finally inline - by :user:`gaborbernat`.
2441 (:issue:`2264`)
2442 - Legacy parallel mode should accept ``-p`` flag without arguments - by :user:`gaborbernat`. (:issue:`2299`)
2443 - Sequential run fails because the packaging environment is deleted twice for sequential runs with recreate flag on - by
2444 :user:`gaborbernat`. (:issue:`2300`)
2445 - Require Python 3.10 to generate docs - by :user:`jugmac00`. (:issue:`2321`)
2446 - Environment assignment for output breaks when using ``-rv`` (when we cannot guess upfront the verbosity level from the
2447 CLI arguments) - by :user:`gaborbernat`. (:issue:`2324`)
2448 - ``devenv`` command does not respect specified path - by :user:`gaborbernat`. (:issue:`2325`)
2449
2450 Improved Documentation - 4.0.0b1
2451 ================================
2452
2453 - Enable link check during documentation build - by :user:`gaborbernat`. (:issue:`806`)
2454 - Document ownership of the ``tox.wiki`` root domain - by :user:`gaborbernat`. (:issue:`2242`)
2455 - Document :meth:`tox.config.sets.ConfigSet.loaders` - by :user:`gaborbernat`. (:issue:`2287`)
2456 - Fix CLI documentation is missing and broken documentation references - by :user:`gaborbernat`. (:issue:`2310`)
2457
2458 ************************
2459 v4.0.0a10 (2022-01-04)
2460 ************************
2461
2462 Features - 4.0.0a10
2463 ===================
2464
2465 - Support for grouping environment values together by applying labels to them either at :ref:`core <labels>` and
2466 :ref:`environment <labels-env>` level, and allow selecting them via the :ref:`-m <tox-run--m>` flag from the CLI - by
2467 :user:`gaborbernat`. (:issue:`238`)
2468 - Support for environment files within the :ref:`set_env` configuration via the ``file|`` prefix - by
2469 :user:`gaborbernat`. (:issue:`1938`)
2470 - Support for ``--no-provision`` flag - by :user:`gaborbernat`. (:issue:`1951`)
2471 - Missing ``pyproject.toml`` or ``setup.py`` file at the tox root folder without the ``--install-pkg`` flag assumes no
2472 packaging - by :user:`gaborbernat`. (:issue:`1964`)
2473 - Add ``external`` package type for :ref:`package` (see :ref:`external-package-builder`), and extract package
2474 dependencies for packages passed in via :ref:`--installpkg <tox-run---installpkg>` - by :user:`gaborbernat`.
2475 (:issue:`2204`)
2476 - Add support for rewriting script invocations that have valid shebang lines when the ``TOX_LIMITED_SHEBANG``
2477 environment variable is set and not empty - by :user:`gaborbernat`. (:issue:`2208`)
2478 - Support for the ``--discover`` CLI flag - by :user:`gaborbernat`. (:pr:`2245`)
2479 - Moved the python packaging logic into a dedicate package :pypi:`pyproject-api` and use it as a dependency - by
2480 :user:`gaborbernat`. (:pr:`2274`)
2481 - Drop python 3.6 support - by :user:`gaborbernat`. (:pr:`2275`)
2482 - Support for selecting target environments with a given factor via the :ref:`-f <tox-run--f>` CLI environment flag - by
2483 :user:`gaborbernat`. (:pr:`2290`)
2484
2485 Bugfixes - 4.0.0a10
2486 ===================
2487
2488 - Fix ``CTRL+C`` is not stopping the process on Windows - by :user:`gaborbernat`. (:issue:`2159`)
2489 - Fix list/depends commands can create tox package environment as runtime environment and display an error message - by
2490 :user:`gaborbernat`. (:pr:`2234`)
2491
2492 Deprecations and Removals - 4.0.0a10
2493 ====================================
2494
2495 - ``tox_add_core_config`` and ``tox_add_env_config`` now take a ``state: State`` argument instead of a configuration
2496 one, and ``Config`` not longer provides the ``envs`` property (instead users should migrate to ``State.envs``) - by
2497 :user:`gaborbernat`. (:pr:`2275`)
2498
2499 ***********************
2500 v4.0.0a9 (2021-09-16)
2501 ***********************
2502
2503 Features - 4.0.0a9
2504 ==================
2505
2506 - Expose the parsed CLI arguments on the main configuration object for plugins and allow plugins to define their own
2507 configuration section -- by :user:`gaborbernat`. (:pr:`2191`)
2508 - Let tox run fail when all envs are skipped -- by :user:`jugmac00`. (:issue:`2195`)
2509 - Expose the configuration loading mechanism to plugins to define and load their own sections. Add
2510 :meth:`tox_add_env_config <tox.plugin.spec.tox_add_env_config>` plugin hook called after the configuration environment
2511 is created for a tox environment and removed ``tox_configure``. Add the main configuration object as argument to
2512 :meth:`tox_add_core_config <tox.plugin.spec.tox_add_core_config>`. Move the environment list method from the state to
2513 the main configuration object to allow its use within plugins -- by :user:`gaborbernat`. (:issue:`2200`)
2514 - Allow running code in plugins before and after commands via :meth:`tox_before_run_commands
2515 <tox.plugin.spec.tox_before_run_commands>` and :meth:`tox_after_run_commands <tox.plugin.spec.tox_after_run_commands>`
2516 plugin points -- by :user:`gaborbernat`. (:issue:`2201`)
2517 - Allow plugins to update the :ref:`set_env` and change the :ref:`pass_env` configurations -- by :user:`gaborbernat`.
2518 (:issue:`2215`)
2519
2520 Bugfixes - 4.0.0a9
2521 ==================
2522
2523 - Fix env variable substitutions with defaults containing colon (e.g. URL) -- by :user:`comabrewer`. (:issue:`2182`)
2524 - Do not allow constructing ``ConfigSet`` directly and implement ``__contains__`` for ``Loader`` -- by
2525 :user:`gaborbernat`. (:pr:`2209`)
2526 - Fix old-new value on recreate cache miss-match are swapped -- by :user:`gaborbernat`. (:issue:`2211`)
2527 - Report fails when report does not support Unicode characters -- by :user:`gaborbernat`. (:issue:`2213`)
2528
2529 Improved Documentation - 4.0.0a9
2530 ================================
2531
2532 - Adopt furo theme, update our state diagram and description in user docs (SVG + light/dark variant), split the Python
2533 API into its own page from under the plugin page, and document plugin adoption under the ``tox-dev`` organization - by
2534 :user:`gaborbernat`. (:issue:`1881`)
2535
2536 ***********************
2537 v4.0.0a8 (2021-08-21)
2538 ***********************
2539
2540 Features - 4.0.0a8
2541 ==================
2542
2543 - Add support for :ref:`allowlist_externals`, commands not matching error - by :user:`gaborbernat`. (:issue:`1127`)
2544 - Add outcome of environments into the result json (:ref:`--result-json <tox-run---result-json>`) under the ``result``
2545 key containing ``success`` boolean, ``exit_code`` integer and ``duration`` float value - by :user:`gaborbernat`.
2546 (:issue:`1405`)
2547 - Add ``exec`` subcommand that allows users to run an arbitrary command within the tox environment (without needing to
2548 modify their configuration) - by :user:`gaborbernat`. (:issue:`1790`)
2549 - Add check to validate the base Python names and the environments name do not conflict Python spec wise, when they do
2550 raise error if :ref:`ignore_base_python_conflict` is not set or ``False`` - by :user:`gaborbernat`. (:issue:`1840`)
2551 - Allow any Unix shell-style wildcards expression for :ref:`pass_env` - by :user:`gaborbernat`. (:issue:`2121`)
2552 - Add support for :ref:`args_are_paths` flag - by :user:`gaborbernat`. (:issue:`2122`)
2553 - Add support for :ref:`env_log_dir` (compared to tox 3 extend content and keep only last run entries) - by
2554 :user:`gaborbernat`. (:issue:`2123`)
2555 - Add support for ``{:}`` substitution in ini files as placeholder for the OS path separator - by :user:`gaborbernat`.
2556 (:issue:`2125`)
2557 - When cleaning directories (for tox environment, ``env_log_dir``, ``env_tmp_dir`` and packaging metadata folders) do
2558 not delete the directory itself and recreate, but instead just delete its content (this allows the user to cd into it
2559 and still be in a valid folder after a new run) - by :user:`gaborbernat`. (:pr:`2139`)
2560 - Changes to help plugin development: simpler tox env creation argument list, expose python creation directly, allow
2561 skipping list dependencies install command for pip and executable is only part of the python cache for virtualenv - by
2562 :user:`gaborbernat`. (:pr:`2172`)
2563
2564 Bugfixes - 4.0.0a8
2565 ==================
2566
2567 - Support ``#`` character in path for the tox project - by :user:`gaborbernat`. (:issue:`763`)
2568 - If the command expression fails to parse with shlex fallback to literal pass through of the remaining elements - by
2569 :user:`gaborbernat`. (:issue:`1944`)
2570 - tox config fails on :ref:`--recreate <tox-config---recreate>` flag, and once specified the output does not reflect the
2571 impact of the CLI flags - by :user:`gaborbernat`. (:issue:`2037`)
2572 - Virtual environment creation for Python is always triggered at every run - by :user:`gaborbernat`. (:issue:`2041`)
2573 - Add support for setting :ref:`suicide_timeout`, :ref:`interrupt_timeout` and :ref:`terminate_timeout` - by
2574 :user:`gaborbernat`. (:issue:`2124`)
2575 - Parallel show output not working when there's a packaging phase in the run - by :user:`gaborbernat`. (:pr:`2161`)
2576
2577 Improved Documentation - 4.0.0a8
2578 ================================
2579
2580 - Note constraint files are a subset of requirement files - by :user:`gaborbernat`. (:issue:`1939`)
2581 - Add a note about having a package with different Python requirements than tox and not specifying :ref:`base_python` -
2582 by :user:`gaborbernat`. (:issue:`1975`)
2583 - Fix :ref:`--runner <tox---runner>` is missing default value and documentation unclear - by :user:`gaborbernat`.
2584 (:issue:`2004`)
2585
2586 ***********************
2587 v4.0.0a7 (2021-07-28)
2588 ***********************
2589
2590 Features - 4.0.0a7
2591 ==================
2592
2593 - Add support for configuration taken from the ``setup.cfg`` file -by :user:`gaborbernat`. (:issue:`1836`)
2594 - Add support for configuration taken from the ``pyproject.toml`` file, ``tox`` section ``legacy_tox_ini`` key - by
2595 :user:`gaborbernat`. (:issue:`1837`)
2596 - Add configuration documentation - by :user:`gaborbernat`. (:issue:`1914`)
2597 - Implemented ``[]`` substitution (alias for ``{posargs}``) - by :user:`hexagonrecursion`. (:issue:`1928`)
2598 - Implement ``[testenv] ignore_outcome`` - "a failing result of this testenv will not make tox fail" - by
2599 :user:`hexagonrecursion`. (:issue:`1947`)
2600 - Inline plugin support via ``tox_.py``. This is loaded where the tox config source is discovered. It's a Python file
2601 that can contain arbitrary Python code, such as definition of a plugin. Eventually we'll add a plugin that allows
2602 succinct declaration/generation of new tox environments - by :user:`gaborbernat`. (:pr:`1963`)
2603 - Introduce the installer concept, and collect pip installation into a ``pip`` package, also attach to this the
2604 requirements file parsing which got a major rework - by :user:`gaborbernat`. (:pr:`1991`)
2605 - Support CPython ``3.10`` -by :user:`gaborbernat`. (:pr:`2014`)
2606
2607 Bugfixes - 4.0.0a7
2608 ==================
2609
2610 - Environments with a platform mismatch are no longer silently skipped, but properly reported - by :user:`jugmac00`.
2611 (:issue:`1926`)
2612 - Port pip requirements file parser to ``tox`` to achieve full equivalency (such as support for the per requirement
2613 ``--install-option`` and ``--global-option`` flags) - by :user:`gaborbernat`. (:issue:`1929`)
2614 - Support for extras with paths for Python deps and requirement files - by :user:`gaborbernat`. (:issue:`1933`)
2615 - Due to a bug ``\{posargs} {posargs}`` used to expand to literal ``{posargs} {posargs}``. Now the second ``{posargs}``
2616 is expanded. ``\{posargs} {posargs}`` expands to ``{posargs} positional arguments here`` - by
2617 :user:`hexagonrecursion`. (:issue:`1956`)
2618 - Enable setting a different ``upstream`` repository for the coverage diff report. This has been hardcoded to
2619 ``upstream/rewrite`` until now. by :user:`jugmac00`. (:issue:`1972`)
2620 - Enable replacements (a.k.a section substitutions) for section names containing a dash in sections without the
2621 ``testenv:`` prefix - by :user:`jugmac00`, :user:`obestwalter`, :user:`eumiro`. (:issue:`1985`)
2622 - Fix legacy list env command for empty/missing envlist - by :user:`jugmac00`. (:issue:`1987`)
2623 - Requirements and constraints files handling got reimplemented, which should fix all open issues related to this area -
2624 by :user:`gaborbernat`. (:pr:`1991`)
2625 - Use importlib instead of ``__import__`` - by :user:`dmendek`. (:issue:`1995`)
2626 - Evaluate factor conditions for ``command`` keys - by :user:`jugmac00`. (:issue:`2002`)
2627 - Prefer f-strings instead of the str.format method - by :user:`eumiro`. (:issue:`2012`)
2628 - Fix regex validation for SHA 512 hashes - by :user:`jugmac00`. (:issue:`2018`)
2629 - Actually run all environments when ``ALL`` is provided to the legacy env command - by :user:`jugmac00`.
2630 (:issue:`2112`)
2631 - Move from ``appdirs`` to ``platformdirs`` - by :user:`gaborbernat`. (:pr:`2117`)
2632 - Move from ``toml`` to ``tomli`` - by :user:`gaborbernat`. (:pr:`2118`)
2633
2634 Improved Documentation - 4.0.0a7
2635 ================================
2636
2637 - Start documenting the plugin interface. Added :meth:`tox_register_tox_env <tox.plugin.spec.tox_register_tox_env>`,
2638 :meth:`tox_add_option <tox.plugin.spec.tox_add_option>`, :meth:`tox_add_core_config
2639 <tox.plugin.spec.tox_add_core_config>`, ``tox_configure`` - by :user:`gaborbernat`. (:pr:`1991`)
2640 - Explain how ``-v`` and ``-q`` flags play together to determine CLI verbosity level - by :user:`jugmac00`.
2641 (:issue:`2005`)
2642 - Start polishing the documentation for the upcoming final release - by :user:`jugmac00`. (:pr:`2006`)
2643 - Update documentation about changelog entries for trivial changes - by :user:`jugmac00`. (:issue:`2007`)
2644
2645 ***********************
2646 v4.0.0a6 (2021-02-15)
2647 ***********************
2648
2649 Features - 4.0.0a6
2650 ==================
2651
2652 - Add basic quickstart implementation (just use pytest with the current Python version) - by :user:`gaborbernat`.
2653 (:issue:`1829`)
2654 - Support comments via the ``#`` character within the ini configuration (to force a literal ``#`` use ``\#``) - by
2655 :user:`gaborbernat`. (:issue:`1831`)
2656 - Add support for the ``install_command`` settings in the virtual env test environments - by :user:`gaborbernat`.
2657 (:issue:`1832`)
2658 - Add support for the ``package_root`` ``setupdir`` ( Python scoped) configuration that sets the root directory used for
2659 packaging (the location of the historical ``setup.py`` and modern ``pyproject.toml``). This can be set at root level,
2660 or at tox environment level (the later takes precedence over the former) - by :user:`gaborbernat`. (:issue:`1838`)
2661 - Implement support for the ``--installpkg`` CLI flag - by :user:`gaborbernat`. (:issue:`1839`)
2662 - Add support for the ``list_dependencies_command`` settings in the virtual env test environments - by
2663 :user:`gaborbernat`. (:issue:`1842`)
2664 - Add support for the ``ignore_errors`` settings in tox test environments - by :user:`gaborbernat`. (:issue:`1843`)
2665 - Add support for the ``pip_pre`` settings for virtual environment based tox environments - by :user:`gaborbernat`.
2666 (:issue:`1844`)
2667 - Add support for the ``platform`` settings in tox test environments - by :user:`gaborbernat`. (:issue:`1845`)
2668 - Add support for the ``recreate`` settings in tox test environments - by :user:`gaborbernat`. (:issue:`1846`)
2669 - Allow Python test and packaging environments with version 2.7 - by :user:`gaborbernat`. (:pr:`1900`)
2670 - Do not construct a requirements file for deps in virtualenv, instead pass content as CLI argument to pip - by
2671 :user:`gaborbernat`. (:pr:`1906`)
2672 - Do not display status update environment reports when interrupted or for the final environment ran (because at the
2673 final report will be soon printed and makes the status update redundant) - by :user:`gaborbernat`. (:issue:`1909`)
2674 - The ``_TOX_SHOW_THREAD`` environment variable can be used to print alive threads when tox exists (useful to debug when
2675 tox hangs because of some non-finished thread) and also now prints the pid of the local subprocess when reporting the
2676 outcome of an execution - by :user:`gaborbernat`. (:pr:`1915`)
2677
2678 Bugfixes - 4.0.0a6
2679 ==================
2680
2681 - Normalize description text to collapse newlines and one or more than whitespace to a single space - by
2682 :user:`gaborbernat`. (:issue:`1829`)
2683 - Support aliases in show config key specification (will print with the primary key) - by :user:`gaborbernat`.
2684 (:issue:`1831`)
2685 - Show config no longer marks as unused keys that are inherited (e.g. if the key is coming from ``testenv`` section and
2686 our target is ``testenv:fix``) - by :user:`gaborbernat`. (:issue:`1833`)
2687 - ``--alwayscopy`` and ``--sitepackages`` legacy only flags do not work - by :user:`gaborbernat`. (:issue:`1839`)
2688 - Fix handling of ``commands_pre``/``commands``/``commands_post`` to be in line with tox 3 (returned incorrect exit
2689 codes and post was not always executed) - by :user:`gaborbernat`. (:issue:`1843`)
2690 - Support requirement files containing ``--hash`` constraints - by :user:`gaborbernat`. (:issue:`1903`)
2691 - Fix a bug that caused tox to never finish when pulling configuration from a tox run environment that was never
2692 executed - by :user:`gaborbernat`. (:pr:`1915`)
2693
2694 Deprecations and Removals - 4.0.0a6
2695 ===================================
2696
2697 - - Drop support for ``sdistsrc`` flag because introduces a significant complexity and is barely used (5 hits on a
2698 github search).
2699 - ``--skip-missing-interpreters``, ``--notest``, ``--sdistonly``, ``--installpkg``, ``--develop`` and
2700 ``--skip-pkg-install`` CLI flags are no longer available for ``devenv`` (enforce the only sane value for these).
2701
2702 By :user:`gaborbernat` (:issue:`1839`)
2703
2704 - Remove Jenkins override support: this feature goes against the spirit of tox - blurring the line between the CI and
2705 local runs. It also singles out a single CI provider, which opens the door for other CIs wanting similar
2706 functionality. Finally, only 54 code file examples came back on a Github search, showing this is a not widely used
2707 feature. People who still want Jenkins override support may create a tox plugin to achieve this functionality - by
2708 :user:`gaborbernat`. (:issue:`1841`)
2709
2710 ***********************
2711 v4.0.0a5 (2021-01-23)
2712 ***********************
2713
2714 Features - 4.0.0a5
2715 ==================
2716
2717 - Support the ``system_site_packages``/``sitepackages`` flag for virtual environment based tox environments - by
2718 :user:`gaborbernat`. (:issue:`1847`)
2719 - Support the ``always_copy``/``alwayscopy`` flag for virtual environment based tox environments - by
2720 :user:`gaborbernat`. (:issue:`1848`)
2721 - Support the ``download`` flag for virtual environment based tox environments - by :user:`gaborbernat`. (:issue:`1849`)
2722 - Recreate virtual environment based tox environments when the ``virtualenv`` version changes - by :user:`gaborbernat`.
2723 (:issue:`1865`)
2724
2725 Bugfixes - 4.0.0a5
2726 ==================
2727
2728 - Not all package dependencies are installed when different tox environments in the same run use different set of extras
2729 - by :user:`gaborbernat`. (:issue:`1868`)
2730 - Support ``=`` separator in requirement file flags, directories as requirements and correctly set the root of the
2731 requirements file when using the ``--root`` CLI flag to change the root - by :user:`gaborbernat`. (:issue:`1853`)
2732 - Cleanup local subprocess file handlers when exiting runs (fixes ``ResourceWarning: unclosed file`` errors when running
2733 with ``env PYTHONTRACEMALLOC=5 PYTHONDEVMODE=y`` under a Python built with ``--with-pydebug``) - by
2734 :user:`gaborbernat`. (:issue:`1857`)
2735 - Various small bugfixes:
2736
2737 - honor updating default environment variables set by internal tox via set env (``PIP_DISABLE_PIP_VERSION_CHECK``)
2738 - do not multi-wrap ``HandledError`` in the ini file loader,
2739 - skipped environments are logged now with their fail message at default verbosity level,
2740 - fix an error that made the show configuration command crash when making the string of a config value failed,
2741 - support empty-new lines within the set env configurations replacements,
2742
2743 by :user:`gaborbernat`. (:pr:`1864`)
2744
2745 Improved Documentation - 4.0.0a5
2746 ================================
2747
2748 - Add CLI documentation - by :user:`gaborbernat`. (:pr:`1852`)
2749
2750 ***********************
2751 v4.0.0a4 (2021-01-16)
2752 ***********************
2753
2754 Features - 4.0.0a4
2755 ==================
2756
2757 - Use ``.tox/4`` instead of ``.tox4`` folder (so ignores for tox 3 works for tox 4 too), reminder we'll rename this to
2758 just ``.tox`` before public release, however to encourage testing tox 4 in parallel with tox 3 this is helpful - by
2759 :user:`gaborbernat`. (:discussion:`1812`)
2760 - Colorize the ``config`` command: section headers are yellow, keys are green, values remained white, exceptions are
2761 light red and comments are cyan - by :user:`gaborbernat`. (:pr:`1821`)
2762
2763 Bugfixes - 4.0.0a4
2764 ==================
2765
2766 - Support legacy format (``-cconstraint.txt``) of constraint files in ``deps``, and expand constraint files too when
2767 viewing inside the ``deps`` or calculating weather our environment is up to date or not - by :user:`gaborbernat`.
2768 (:issue:`1788`)
2769 - When specifying requirements/editable/constraint paths within ``deps`` escape space, unless already escaped to support
2770 running specifying transitive requirements files within deps - by :user:`gaborbernat`. (:issue:`1792`)
2771 - When using a provisioned tox environment requesting ``--recreate`` failed with ``AttributeError`` - by
2772 :user:`gaborbernat`. (:issue:`1793`)
2773 - Fix ``RequirementsFile`` from tox is rendered incorrectly in ``config`` command - by :user:`gaborbernat`.
2774 (:issue:`1820`)
2775 - Fix a bug in the configuration system where referring to the same named key in another env/section causes circular
2776 dependency error - by :user:`gaborbernat`. (:pr:`1821`)
2777 - Raise ``ValueError`` with descriptive message when a requirements file specified does not exist - by
2778 :user:`gaborbernat`. (:pr:`1828`)
2779 - Support all valid requirement file specification without delimiting space in the ``deps`` of the ``tox.ini`` - by
2780 :user:`gaborbernat`. (:issue:`1834`)
2781
2782 Improved Documentation - 4.0.0a4
2783 ================================
2784
2785 - Add code style guide for contributors - by :user:`gaborbernat`. (:issue:`1734`)
2786
2787 ***********************
2788 v4.0.0a3 (2021-01-13)
2789 ***********************
2790
2791 Features - 4.0.0a3
2792 ==================
2793
2794 - Raise exception when set env enters into a circular reference - by :user:`gaborbernat`. (:issue:`1779`)
2795 - - Raise exception when variable substitution enters into a circle.
2796 - Add ``{/}`` as substitution for os specific path separator.
2797 - Add ``{env_bin_dir}`` constant substitution.
2798 - Implement support for ``--discover`` flag - by :user:`gaborbernat`. (:pr:`1784`)
2799
2800 Bugfixes - 4.0.0a3
2801 ==================
2802
2803 - Entries in the ``set_env`` does not reference environments from ``set_env`` - by :user:`gaborbernat`. (:issue:`1776`)
2804 - ``env`` substitution does not uses values from ``set_env`` - by :user:`gaborbernat`. (:issue:`1779`)
2805 - Adopt tox 3 base pass env list, by adding:
2806
2807 - on all platforms: ``LANG``, ``LANGUAGE``, ``CURL_CA_BUNDLE``, ``SSL_CERT_FILE`` , ``LD_LIBRARY_PATH`` and
2808 ``REQUESTS_CA_BUNLDE``,
2809 - on Windows: ``SYSTEMDRIVE`` - by :user:`gaborbernat`. (:issue:`1780`)
2810
2811 - Fixed a bug that crashed tox where calling tox with the recreate flag and when multiple environments were reusing the
2812 same package - by :user:`gaborbernat`. (:issue:`1782`)
2813 - - Python version markers are stripped in package dependencies (after wrongfully being detected as an extra marker).
2814 - In packaging APIs do not set ``PYTHONPATH`` (to empty string) if ``backend-path`` is empty.
2815 - Fix commands parsing on Windows (do not auto-escape ``\`` - instead users should use the new ``{\}``, and on parsed
2816 arguments strip both ``'`` and ``"`` quoted outcomes).
2817 - Allow windows paths in substitution set/default (the ``:`` character used to separate substitution arguments may
2818 also be present in paths on Windows - do not support single capital letter values as substitution arguments) - by
2819 :user:`gaborbernat`. (:pr:`1784`)
2820 - Rework how we handle Python packaging environments:
2821
2822 - the base packaging environment changed from ``.package`` to ``.pkg``,
2823 - merged the ``sdist``, ``wheel`` and ``dev`` separate packaging implementations into one, and internally dynamically
2824 pick the one that's needed,
2825 - the base packaging environment always uses the same Python environment as tox is installed into,
2826 - the base packaging environment is used to get the metadata of the project (via PEP-517) and to build ``sdist`` and
2827 ``dev`` packages,
2828 - for building wheels introduced a new per env configurable option ``wheel_build_env``, if the target Python
2829 major/minor and implementation for the run tox environment and the base package tox environment matches set this to
2830 ``.pkg``, otherwise this is ``.pkg-{implementation}{major}{minor}``,
2831 - internally now packaging environments can create further packaging environments they are responsible of managing,
2832 - updated ``depends`` to use the packaging logic,
2833 - add support skip missing interpreters for depends and show config,
2834
2835 by :user:`gaborbernat`. (:issue:`1804`)
2836
2837 ***********************
2838 v4.0.0a2 (2021-01-09)
2839 ***********************
2840
2841 Features - 4.0.0a2
2842 ==================
2843
2844 - Add option to disable colored output, and support ``NO_COLOR`` and ``FORCE_COLOR`` environment variables - by
2845 :user:`gaborbernat`. (:pr:`1630`)
2846
2847 Bugfixes - 4.0.0a2
2848 ==================
2849
2850 - Fix coverage generation in CI - by :user:`gaborbernat`. (:pr:`1551`)
2851 - Fix the CI failures:
2852
2853 - drop Python 3.5 support as it's not expected to get to a release before EOL,
2854 - fix test using ``\n`` instead of ``os.linesep``,
2855 - Windows Python 3.6 does not contain ``_overlapped.ReadFileInto``
2856 - by :user:`gaborbernat`. (:pr:`1556`)
2857
2858 Improved Documentation - 4.0.0a2
2859 ================================
2860
2861 - Add base documentation by merging virtualenv structure with tox 3 - by :user:`gaborbernat`. (:pr:`1551`)
2862
2863 **********
2864 v4.0.0a1
2865 **********
2866
2867 - First version all is brand new.
2868
2869 .. warning::
2870
2871 The current tox is the second iteration of implementation. From version ``0.5`` all the way to ``3.X`` we numbered
2872 the first iteration. Version ``4.0.0a1`` is a complete rewrite of the package, and as such this release history
2873 starts from there. The old changelog is still available in the `legacy branch documentation
2874 <https://tox.wiki/en/legacy/changelog.html>`_.