Skip to content

Commit

Permalink
Add descriptions to the tox environments. Closes #91.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Sep 10, 2023
1 parent b02bf32 commit a6256e2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[testenv]
description = perform primary checks (tests, style, types, coverage)
deps =
setenv =
PYTHONWARNDEFAULTENCODING = 1
Expand All @@ -9,6 +10,7 @@ extras =
testing

[testenv:diffcov]
description = run tests and check that diff from main is covered
deps =
diff-cover
commands =
Expand All @@ -17,6 +19,7 @@ commands =
diff-cover coverage.xml --compare-branch=origin/main --fail-under=100

[testenv:docs]
description = build the documentation
extras =
docs
testing
Expand All @@ -26,6 +29,7 @@ commands =
python -m sphinxlint

[testenv:finalize]
description = assemble changelog and tag a release
skip_install = True
deps =
towncrier
Expand All @@ -36,6 +40,7 @@ commands =


[testenv:release]
description = publish the package to PyPI and GitHub
skip_install = True
deps =
build
Expand Down

0 comments on commit a6256e2

Please sign in to comment.