[tox]
minversion = 1.6
-envlist = pre-commit,gitlint,docs,docs-linkcheck
+envlist = pre-commit,docs,docs-linkcheck,spelling,gitlint
skipsdist = true
[testenv:docs]
basepython = python3
deps = -rdocs/requirements.txt
commands =
- sphinx-build -q -j auto -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
[testenv:docs-linkcheck]
basepython = python3
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
- pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
- # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
- # Its default arguments --passed and --msg-filename are different from CI recommandations.
- # As a result, the line above is skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file
- # and the HOME variable must be passed to tox virtualenv so that Gitlint can access the git user configuration.
- # A dedicated gitlint profile for CI is proposed below.
+# 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
-rdocs/requirements.txt
sphinxcontrib-spelling
PyEnchant
-commands = sphinx-build -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling
+allowlist_externals = sh
+commands =
+ sh -c 'command enchant>/dev/null || command enchant-2 -v>/dev/null || 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