From: Jeremy Stanley <fungi@yuggoth.org>
Date: Sat, 6 Mar 2021 02:18:42 +0000 (+0000)
Subject: Add descriptions to tox testenvs
X-Git-Tag: 0.4.0~12
X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=commitdiff_plain;h=f3356aa2bcafd54c98a5683554b70f37ed7e9e8f

Add descriptions to tox testenvs

Include a one-line description for each testenv in the tox.ini file,
useful for generally documenting what they're for, and displayed by
the `tox -lv` command.
---

diff --git a/tox.ini b/tox.ini
index 838e491..cfade32 100644
--- a/tox.ini
+++ b/tox.ini
@@ -9,6 +9,7 @@ skipsdist = True
 ignore_basepython_conflict = True
 
 [testenv]
+description = run the functional selftest with optimized configuration
 basepython = python3
 usedevelop = True
 install_command = pip install {opts} {packages}
@@ -25,6 +26,7 @@ commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
 [testenv:bandit]
 setenv =
     PYTHONWARNINGS=error
+description = check for potential security risks in source code
 deps = bandit
 commands = bandit -r mudpy -x mudpy/tests {posargs}
 usedevelop = False
@@ -32,14 +34,17 @@ usedevelop = False
 [testenv:codespell]
 setenv =
     PYTHONWARNINGS=error
+description = find common spelling mistakes in code and documentation
 deps = codespell
 commands = codespell {posargs}
 usedevelop = False
 
 [testenv:demo]
+description = start an interactive demo with the sample config
 commands = mudpy {posargs}
 
 [testenv:dist]
+description = build release artifacts and check for conformance
 allowlist_externals = rm
 deps =
     pbr
@@ -52,6 +57,7 @@ commands =
 usedevelop = False
 
 [testenv:docs]
+description = generate hypertext documentation
 allowlist_externals = rm
 deps =
     -r{toxinidir}/requirements.txt
@@ -65,6 +71,7 @@ usedevelop = False
 [testenv:flake8]
 setenv =
     PYTHONWARNINGS=error
+description = style checks and static analysis of source code
 deps =
     flake8
     flake8-bugbear
@@ -72,11 +79,13 @@ commands = flake8 {posargs}
 usedevelop = False
 
 [testenv:selftest_config]
+description = run the selftest with the included sample config
 commands = mudpy_selftest etc/mudpy.yaml
 
 [testenv:yamllint]
 setenv =
     PYTHONWARNINGS=error
+description = test data files for correct syntax and formatting
 deps = yamllint
 commands = yamllint --strict {posargs} .
 usedevelop = False