Fix: Update release guide to mvn39 and JDK21
[docs.git] / tox.ini
diff --git a/tox.ini b/tox.ini
index 38d56c8eb8f7e14d35dc52414100b7196e5a354d..7d840531be65110a6a05d4cf90b92a92ccad23bb 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,26 +1,66 @@
 [tox]
 minversion = 1.6
-envlist = coala,docs,docs-linkcheck
+envlist = pre-commit,docs,docs-linkcheck,spelling,gitlint
 skipsdist = true
 
-[testenv:coala]
+[testenv:docs]
 basepython = python3
-deps =
-    coala
-    coala-bears
-    nodeenv
+deps = -rdocs/requirements.txt
 commands =
-    nodeenv -p
-    npm install --global remark-cli remark-lint
-    coala --non-interactive
+    sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
-[testenv:docs]
-deps = -rrequirements.txt
+[testenv:docs-linkcheck]
+basepython = python3
+deps = -rdocs/requirements.txt
+commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
+[testenv:pre-commit-install]
+basepython = python3
+deps = pre-commit
 commands =
-    sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
-    echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+    pre-commit install
+    pre-commit install --hook-type commit-msg
 
-[testenv:docs-linkcheck]
-deps = -rrequirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+[testenv:pre-commit-uninstall]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit uninstall
+    pre-commit uninstall --hook-type commit-msg
+
+[testenv:pre-commit-autoupdate]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit autoupdate
+
+[testenv:pre-commit]
+basepython = python3
+deps = pre-commit
+passenv = HOME
+commands =
+    pre-commit run --all-files --show-diff-on-failure
+# CI minions last upgrade makes pre-commit gitlint deps resolution fail.
+# until it is fixed, let's use native tox profile instead
+#    pre-commit run gitlint-ci --hook-stage manual
+
+[testenv:gitlint]
+basepython = python3
+deps = gitlint
+commands =
+    gitlint
+
+[testenv:spelling]
+basepython = python3
+deps =
+    -rdocs/requirements.txt
+    sphinxcontrib-spelling
+    PyEnchant
+allowlist_externals = sh
+commands =
+    sh -c 'command enchant>/dev/null || \
+           command enchant-2 -v>/dev/null || \
+           (sudo apt-get -qq update &&  sudo apt-get --yes install enchant-2) || \
+           sudo yum -y install enchant || \
+           (echo "enchant command not found - please install it (e.g. sudo apt-get install enchant | yum install enchant )" >&2 && exit 1)'
+    sphinx-build -q -W --keep-going -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling