Tox

-------------------

Bugfixes
^^^^^^^^

- In a posix shell, setting the PATH environment variable to an empty value is equivalent to not setting it at all;
therefore we no longer if the user sets PYTHONPATH an empty string on python 3.4 or later - by :user:`gaborbernat`.
`1092 <https://github.com/tox-dev/tox/issues/1092>`_
- Fixed bug of children process calls logs clashing (log already exists) - by :user:`gaborbernat`
`1137 <https://github.com/tox-dev/tox/issues/1137>`_
- Interpreter discovery and virtualenv creation process calls that failed will now print out on the screen their output
(via the logfile we automatically save) - by :user:`gaborbernat`
`1150 <https://github.com/tox-dev/tox/issues/1150>`_
- Using ``py2`` and ``py3`` with a specific ``basepython`` will no longer raise a warning unless the major version conflicts - by :user:`demosdemon`.
`1153 <https://github.com/tox-dev/tox/issues/1153>`_
- Fix missing error for ``tox -e unknown`` when tox.ini declares ``envlist``. - by :user:`medmunds`
`1160 <https://github.com/tox-dev/tox/issues/1160>`_
- Resolve symlinks with ``toxworkdir`` - by :user:`blueyed`.
`1169 <https://github.com/tox-dev/tox/issues/1169>`_
- Interrupting a tox call (e.g. via CTRL+C) now will ensure that spawn child processes (test calls, interpreter discovery,
parallel sub-instances, provisioned hosts) are correctly stopped before exiting (via the pattern of INTERRUPT - 300 ms,
TERMINATE - 200 ms, KILL signals) - by :user:`gaborbernat`
`1172 <https://github.com/tox-dev/tox/issues/1172>`_
- Fix a ``ResourceWarning: unclosed file`` in ``Action`` - by :user:`BoboTiG`.
`1179 <https://github.com/tox-dev/tox/issues/1179>`_
- Fix deadlock when using ``--parallel`` and having environments with lots of output - by :user:`asottile`.
`1183 <https://github.com/tox-dev/tox/issues/1183>`_
- Removed code that sometimes caused a difference in results between ``--parallel`` and ``-p`` when using ``posargs`` - by :user:`timdaman`
`1192 <https://github.com/tox-dev/tox/issues/1192>`_


Features
^^^^^^^^

- tox now auto-provisions itself if needed (see :ref:`auto-provision`). Plugins or minimum version of tox no longer
need to be manually satisfied by the user, increasing their ease of use. - by :user:`gaborbernat`
`998 <https://github.com/tox-dev/tox/issues/998>`_
- tox will inject the ``TOX_PARALLEL_ENV`` environment variable, set to the current running tox environment name,
only when running in parallel mode. - by :user:`gaborbernat`
`1139 <https://github.com/tox-dev/tox/issues/1139>`_
- Parallel children now save their output to a disk logfile - by :user:`gaborbernat`
`1143 <https://github.com/tox-dev/tox/issues/1143>`_
- Parallel children now are added to ``--result-json`` - by :user:`gaborbernat`
`1159 <https://github.com/tox-dev/tox/issues/1159>`_
- Display pattern and ``sys.platform`` with platform mismatch - by :user:`blueyed`.
`1176 <https://github.com/tox-dev/tox/issues/1176>`_
- Setting the environment variable ``TOX_REPORTER_TIMESTAMP`` to ``1`` will enable showing for each output line its delta
since the tox startup. This can be especially handy when debugging parallel runs.- by :user:`gaborbernat`
`1203 <https://github.com/tox-dev/tox/issues/1203>`_


Documentation
^^^^^^^^^^^^^

- Add a ``poetry`` examples to packaging - by :user:`gaborbernat`
`1163 <https://github.com/tox-dev/tox/issues/1163>`_

-------------------

Features
^^^^^^^^

- Parallel mode added (alternative to ``detox`` which is being deprecated), for more details see :ref:`parallel_mode` - by :user:`gaborbernat`.
`439 <https://github.com/tox-dev/tox/issues/439>`_
- Added command line shortcut ``-s`` for ``--skip-missing-interpreters`` - by :user:`evandrocoan`
`1119 <https://github.com/tox-dev/tox/issues/1119>`_


Deprecations (removal in next major release)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Whitelisting of externals will be mandatory in tox 4: issue a deprecation warning as part of the already existing warning - by :user:`obestwalter`
`1129 <https://github.com/tox-dev/tox/issues/1129>`_


Documentation
^^^^^^^^^^^^^

- Clarify explanations in examples and avoid unsupported end line comments - by :user:`obestwalter`
`1110 <https://github.com/tox-dev/tox/issues/1110>`_
- Set to PULL_REQUEST_TEMPLATE.md use relative instead of absolute URLs - by :user:`evandrocoan`
Fixed PULL_REQUEST_TEMPLATE.md path for changelog/examples.rst to docs/changelog/examples.rst - by :user:`evandrocoan`
`1120 <https://github.com/tox-dev/tox/issues/1120>`_

-------------------

Features
^^^^^^^^

- if the packaging phase successfully builds a package set it as environment variable under ``TOX_PACKAGE`` (useful to make assertions on the built package itself, instead of just how it ends up after installation) - by :user:`gaborbernat` (`1081 <https://github.com/tox-dev/tox/issues/1081>`_)

-------------------

Bugfixes
^^^^^^^^

- On windows, check ``sys.executable`` before others for interpreter version lookup. This matches what happens on non-windows. (`1087 <https://github.com/tox-dev/tox/issues/1087>`_)
- Don't rewrite ``{posargs}`` substitution for absolute paths. (`1095 <https://github.com/tox-dev/tox/issues/1095>`_)
- Correctly fail ``tox --notest`` when setup fails. (`1097 <https://github.com/tox-dev/tox/issues/1097>`_)


Documentation
^^^^^^^^^^^^^

- Update Contributor Covenant URL to use https:// - by :user:`jdufresne`. (`#1082 <https://github.com/tox-dev/tox/issues/1082>`_)
- Correct the capitalization of PyPI throughout the documentation - by :user:`jdufresne`. (`1084 <https://github.com/tox-dev/tox/issues/1084>`_)
- Link to related projects (Invoke and Nox) from the documentation - by :user:`theacodes`. (`1088 <https://github.com/tox-dev/tox/issues/1088>`_)


Miscellaneous
^^^^^^^^^^^^^

- Include the license file in the wheel distribution - by :user:`jdufresne`. (`1083 <https://github.com/tox-dev/tox/issues/1083>`_)

-------------------

Bugfixes
^^^^^^^^

- Fix bug with incorrectly defactorized dependencies - by :user:`bartsanchez` (`706 <https://github.com/tox-dev/tox/issues/706>`_)
- do the same transformation to ``egg_info`` folders that ``pkg_resources`` does;
this makes it possible for hyphenated names to use the ``develop-inst-noop`` optimization (cf. 910),
which previously only worked with non-hyphenated egg names - by
:user:`hashbrowncipher` (`1051 <https://github.com/tox-dev/tox/issues/1051>`_)
- previously, if a project's ``setup.py --name`` emitted extra information to
stderr, tox would capture it and consider it part of the project's name; now,
emissions to stderr are printed to the console - by :user:`hashbrowncipher` (`1052 <https://github.com/tox-dev/tox/issues/1052>`_)
- change the way we acquire interpreter information to make it compatible with ``jython`` interpreter, note to create jython envs one needs ``virtualenv > 16.0`` which will be released later :user:`gaborbernat` (`1073 <https://github.com/tox-dev/tox/issues/1073>`_)


Documentation
^^^^^^^^^^^^^

- document substitutions with additional content starting with a space cannot be alone on a line inside the ini file - by :user:`gaborbernat` (`437 <https://github.com/tox-dev/tox/issues/437>`_)
- change the spelling of a single word from contrains to the proper word, constraints - by :user:`metasyn` (`1061 <https://github.com/tox-dev/tox/issues/1061>`_)
- Mention the minimum version required for ``commands_pre``/``commands_post`` support. (`1071 <https://github.com/tox-dev/tox/issues/1071>`_)

-------------------

Bugfixes
^^^^^^^^

- session packages are now put inside a numbered directory (instead of prefix numbering it,
because pip fails when wheels are not named according to
`PEP-491 <https://www.python.org/dev/peps/pep-0491/#id9>`_, and prefix numbering messes with this)
- by :user:`gaborbernat` (`1042 <https://github.com/tox-dev/tox/issues/1042>`_)


Features
^^^^^^^^

- level three verbosity (``-vvv``) show the packaging output - by :user:`gaborbernat` (`1047 <https://github.com/tox-dev/tox/issues/1047>`_)