Skip to content

Commit aa03606

Browse files
committed
🧪 Use new tox4 setting names consistently
This fixes the mismatch when referencing settings from other sections that might use different alias spellings.
1 parent e8f3b97 commit aa03606

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

tox.ini

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ install_command =
109109
'{envname}' \
110110
'{toxinidir}{/}dependencies{/}' \
111111
install {opts} {packages}
112-
usedevelop = True
112+
use_develop = True
113113

114-
passenv =
114+
pass_env =
115115
WEBTEST_INTERACTIVE
116116
CI
117117
TRAVIS
@@ -126,14 +126,14 @@ passenv =
126126
SSH_AUTH_SOCK
127127
GITHUB_*
128128
CODECOV_TOKEN
129-
setenv =
129+
set_env =
130130
CRYPTOGRAPHY_ALLOW_OPENSSL_102=x
131131
PYTHONDONTWRITEBYTECODE=x
132132
WEBTEST_INTERACTIVE=false
133133

134134

135135
[dists]
136-
setenv =
136+
set_env =
137137
PIP_CONSTRAINT = {toxinidir}{/}dependencies{/}dist-build-constraints.txt
138138
PEP517_OUT_DIR = {env:PEP517_OUT_DIR:{toxinidir}{/}dist}
139139

@@ -142,7 +142,7 @@ setenv =
142142
allowlist_externals =
143143
git
144144
description = Build The Docs
145-
changedir = docs
145+
change_dir = docs
146146
commands_pre =
147147
# Retrieve possibly missing commits:
148148
-git fetch --unshallow
@@ -161,15 +161,15 @@ commands =
161161
-W --keep-going \
162162
-d "{temp_dir}{/}.doctrees" \
163163
. \
164-
"{envdir}{/}docs_out"
164+
"{env_dir}{/}docs_out"
165165

166166
# Print out the output docs dir and a way to serve html:
167167
-{envpython} \
168168
{[python-cli-options]byte-errors} \
169169
{[python-cli-options]some-isolation} \
170170
-c\
171171
'import pathlib;\
172-
docs_dir = pathlib.Path(r"{envdir}") / "docs_out";\
172+
docs_dir = pathlib.Path(r"{env_dir}") / "docs_out";\
173173
index_file = docs_dir / "index.html";\
174174
print(f"\nDocumentation available under \
175175
`file://\{index_file\}`\n\nTo serve docs, use \
@@ -180,13 +180,13 @@ depends =
180180
make-changelog
181181
deps =
182182
-rdependencies{/}tox-docs.in
183-
envdir = {toxworkdir}/build-docs
183+
env_dir = {toxworkdir}/build-docs
184184

185185
[testenv:doctest-docs]
186186
allowlist_externals =
187187
{[testenv:build-docs]allowlist_externals}
188188
description = Doctest The Docs
189-
changedir = {[testenv:build-docs]changedir}
189+
change_dir = {[testenv:build-docs]change_dir}
190190
commands_pre =
191191
commands =
192192
# Retrieve possibly missing commits:
@@ -207,13 +207,13 @@ commands =
207207
commands_post =
208208
deps =
209209
-rdependencies{/}tox-doctest-docs.in
210-
envdir = {[testenv:build-docs]envdir}
210+
env_dir = {[testenv:build-docs]env_dir}
211211

212212
[testenv:linkcheck-docs]
213213
allowlist_externals =
214214
{[testenv:build-docs]allowlist_externals}
215215
description = Linkcheck The Docs
216-
changedir = {[testenv:build-docs]changedir}
216+
change_dir = {[testenv:build-docs]change_dir}
217217
commands_pre =
218218
commands =
219219
# Retrieve possibly missing commits:
@@ -234,13 +234,13 @@ commands =
234234
commands_post =
235235
deps =
236236
-rdependencies{/}tox-docs-linkcheck.in
237-
envdir = {[testenv:build-docs]envdir}
237+
env_dir = {[testenv:build-docs]env_dir}
238238

239239
[testenv:spellcheck-docs]
240240
allowlist_externals =
241241
{[testenv:build-docs]allowlist_externals}
242242
description = Spellcheck The Docs
243-
changedir = {[testenv:build-docs]changedir}
243+
change_dir = {[testenv:build-docs]change_dir}
244244
commands_pre =
245245
commands =
246246
# Retrieve possibly missing commits:
@@ -261,15 +261,15 @@ commands =
261261
commands_post =
262262
deps =
263263
-rdependencies{/}tox-docs-spellcheck.in
264-
envdir = {[testenv:build-docs]envdir}
264+
env_dir = {[testenv:build-docs]env_dir}
265265

266266
[testenv:watch]
267267
commands = ptw --runner=pytest
268268
commands_post =
269269

270270

271271
[testenv:check-changelog]
272-
basepython = {[testenv:make-changelog]basepython}
272+
base_python = {[testenv:make-changelog]base_python}
273273
description =
274274
Check Towncrier change notes
275275
commands_pre =
@@ -282,21 +282,21 @@ commands =
282282
commands_post =
283283
deps =
284284
{[testenv:make-changelog]deps}
285-
envdir = {[testenv:make-changelog]envdir}
285+
env_dir = {[testenv:make-changelog]env_dir}
286286
isolated_build = {[testenv:make-changelog]isolated_build}
287287
skip_install = {[testenv:make-changelog]skip_install}
288288

289289

290290
[testenv:make-changelog]
291-
basepython = python3
291+
base_python = python3
292292
depends =
293293
check-changelog
294294
description =
295295
Generate a changelog from fragments using Towncrier. Getting an
296296
unreleased changelog preview does not require extra arguments.
297297
When invoking to update the changelog, pass the desired version as an
298298
argument after `--`. For example, `tox -e {envname} -- 1.3.2`.
299-
envdir = {[testenv:build-docs]envdir}
299+
env_dir = {[testenv:build-docs]env_dir}
300300
commands_pre =
301301
commands =
302302
{envpython} \
@@ -321,7 +321,7 @@ skip_install = true
321321
[testenv:draft-changelog]
322322
allowlist_externals =
323323
sh
324-
basepython = {[testenv:make-changelog]basepython}
324+
base_python = {[testenv:make-changelog]base_python}
325325
description =
326326
Print out the Towncrier-managed change notes
327327
draft for the next release to stdout
@@ -338,7 +338,7 @@ commands =
338338
--version '[UNRELEASED DRAFT]' \
339339
--draft"
340340
commands_post =
341-
envdir = {[testenv:make-changelog]envdir}
341+
env_dir = {[testenv:make-changelog]env_dir}
342342
deps =
343343
{[testenv:make-changelog]deps}
344344
isolated_build = {[testenv:make-changelog]isolated_build}
@@ -348,11 +348,11 @@ skip_install = {[testenv:make-changelog]skip_install}
348348
[testenv:cleanup-dists]
349349
description =
350350
Wipe the the dist{/} folder
351-
usedevelop = false
351+
use_develop = false
352352
skip_install = true
353353
deps =
354-
setenv =
355-
{[dists]setenv}
354+
set_env =
355+
{[dists]set_env}
356356
commands_pre =
357357
commands =
358358
{envpython} \
@@ -384,15 +384,15 @@ install_command =
384384
'{toxinidir}{/}dependencies{/}' \
385385
install {opts} {packages}
386386
isolated_build = true
387-
# `usedevelop = true` overrides `skip_install` instruction, it's unwanted
388-
usedevelop = false
387+
# `use_develop = true` overrides `skip_install` instruction, it's unwanted
388+
use_develop = false
389389
skip_install = true
390390
deps =
391391
-rdependencies{/}tox-build-dists.in
392-
passenv =
392+
pass_env =
393393
PEP517_BUILD_ARGS
394-
setenv =
395-
{[dists]setenv}
394+
set_env =
395+
{[dists]set_env}
396396
commands_pre =
397397
commands =
398398
# Starting with build v0.5.0, it builds wheel from sdist
@@ -411,7 +411,7 @@ commands_post =
411411

412412
[testenv:pre-commit]
413413
description =
414-
Run the quality checks under {basepython}; run as
414+
Run the quality checks under {base_python}; run as
415415
`SKIP=check-id1,check-id2 tox r -e pre-commit` to instruct the underlying
416416
`pre-commit` invocation avoid running said checks; Use
417417
`tox r -e pre-commit -- check-id1 --all-files` to select checks matching IDs
@@ -541,15 +541,15 @@ depends =
541541
deps =
542542
setuptools-scm
543543
twine
544-
usedevelop = false
544+
use_develop = false
545545
skip_install = true
546546
commands_pre =
547547
{envpython} \
548548
{[python-cli-options]byte-errors} \
549549
{[python-cli-options]some-isolation} \
550550
-m setuptools_scm ls
551-
setenv =
552-
{[dists]setenv}
551+
set_env =
552+
{[dists]set_env}
553553
commands =
554554
{envpython} \
555555
{[python-cli-options]byte-errors} \
@@ -565,9 +565,9 @@ deps =
565565
pep517>=0.5
566566
twine>=1.13
567567
path.py
568-
passenv =
568+
pass_env =
569569
TWINE_PASSWORD
570-
setenv =
570+
set_env =
571571
TWINE_USERNAME = {env:TWINE_USERNAME:__token__}
572572
commands_pre =
573573
commands =

0 commit comments

Comments
 (0)