From 8ea6f0dd3cf09cd0056adcc2b485ee08bbb70fa8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Tue, 6 Dec 2022 10:29:32 +0100 Subject: [PATCH] Remove deprecated `whitelist_externals` configuration option `whitelist_externals` was replaced by `allowlist_externals` and has been deprecatd since then. Also see https://tox.wiki/en/3.18.1/changelog.html#v3-18-0-2020-07-23 --- docs/changelog/2599.removal.rst | 1 + docs/config.rst | 2 +- src/tox/tox_env/api.py | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 docs/changelog/2599.removal.rst diff --git a/docs/changelog/2599.removal.rst b/docs/changelog/2599.removal.rst new file mode 100644 index 000000000..54f15dcf1 --- /dev/null +++ b/docs/changelog/2599.removal.rst @@ -0,0 +1 @@ +Remove deprecated configuration option ``whitelist_externals`` which was replaced by ``allowlist_externals`` - by :user:`jugmac00`. diff --git a/docs/config.rst b/docs/config.rst index 64bbcdd45..09826039d 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -312,7 +312,7 @@ Base options Always recreate virtual environment if this option is true, otherwise leave it up to tox. .. conf:: - :keys: allowlist_externals, whitelist_externals + :keys: allowlist_externals :default: Each line specifies a command name (in glob-style pattern format) which can be used in the commands section even if diff --git a/src/tox/tox_env/api.py b/src/tox/tox_env/api.py index 43a039e64..abcdc78b4 100644 --- a/src/tox/tox_env/api.py +++ b/src/tox/tox_env/api.py @@ -154,7 +154,7 @@ def pass_env_post_process(values: list[str]) -> list[str]: desc="always recreate virtual environment if this option is true, otherwise leave it up to tox", ) self.conf.add_config( - keys=["allowlist_externals", "whitelist_externals"], + "allowlist_externals", of_type=List[str], default=[], desc="external command glob to allow calling",