Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a FAQ entry about tox v3 - v4 compatibility #2601

Merged
merged 7 commits into from
Dec 7, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,50 @@ FAQ

Here you'll find answers to some frequently asked questions.

Compatibility between tox version 3 and 4
-----------------------------------------

Version 4 of tox should be mostly backwards compatible with version 3,
with the following exceptions:


Plugin system
^^^^^^^^^^^^^

As the plugin system has changed,
plugins written for tox version 3 are not compatible with version 4.

Please refer to the `plugin documentation <https://tox.wiki/en/latest/plugins.html>`_.

Configuration operations
^^^^^^^^^^^^^^^^^^^^^^^^

- The ``indexserver`` configuration option has been removed.
Please use the ``PIP_INDEX_URL`` environment variable instead.
gaborbernat marked this conversation as resolved.
Show resolved Hide resolved
- The ``whitelist_externals`` configuration option has been removed.
Please use ``allowlist_externals`` instead.
- Now you need to use ``allowlist_externals`` when using a command which is available globally,
but not installed in the ``testenv``.

Substitutions
^^^^^^^^^^^^^
- The ``distshare`` substitution has been removed.

CLI arguments
^^^^^^^^^^^^^
- The ``parallel--safe-build`` CLI argument has been removed.
- When you want to pass an option to a test command, e.g. to ``pytest``,
you need to use ``--`` as a separator.

Further news
^^^^^^^^^^^^
- tox version 4 now uses isolated builds by default.
- tox offers now built-in wheel support.
- tox offers now editable wheel support.
- tox now uses fancy colors for reporting.
- tox now fails when you mistype an env name.


Using a custom PyPI server
--------------------------

Expand Down