Remove deprecated whitelist_externals configuration option (#2600)

jugmac00 · web-flow · commit 529c2a1d8ee6 · 2022-12-06T10:25:54.000-08:00
fixes #2599
diff --git a/docs/changelog/2599.removal.rst 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
@@ -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: <empty list>
 
    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
@@ -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",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Remove deprecated configuration option ``whitelist_externals`` which was replaced by ``allowlist_externals`` - by :user:`jugmac00`.
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ def pass_env_post_process(values: list[str]) -> list[str]:`
`154`	`154`	`desc="always recreate virtual environment if this option is true, otherwise leave it up to tox",`
`155`	`155`	`)`
`156`	`156`	`self.conf.add_config(`
`157`		`- keys=["allowlist_externals", "whitelist_externals"],`
	`157`	`+ "allowlist_externals",`
`158`	`158`	`of_type=List[str],`
`159`	`159`	`default=[],`
`160`	`160`	`desc="external command glob to allow calling",`