tox.ini

   1 [tox]
   2 minversion = 1.6.0
   3 envlist = docs,pre-commit,gitlint
   4 # TODO: Include docs when it starts performing strict checks.
   5 skipsdist = true
   6
   7 [testenv:docs]
   8 basepython = python3
   9 deps = -rdocs/requirements.txt
  10 commands =
  11     sphinx-build -W -n -b html -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
  12
  13 [testenv:pre-commit-install]
  14 basepython = python3
  15 deps = pre-commit
  16 commands =
  17     pre-commit install
  18     pre-commit install --hook-type commit-msg
  19
  20 [testenv:pre-commit-uninstall]
  21 basepython = python3
  22 deps = pre-commit
  23 commands =
  24     pre-commit uninstall
  25     pre-commit uninstall --hook-type commit-msg
  26
  27 [testenv:pre-commit-autoupdate]
  28 basepython = python3
  29 deps = pre-commit
  30 commands =
  31     pre-commit autoupdate
  32
  33 [testenv:pre-commit]
  34 basepython = python3
  35 deps = pre-commit
  36 passenv = HOME
  37 commands =
  38     pre-commit run --all-files --show-diff-on-failure
  39 # FIXME: run gitlint with pre-commit once the following installation issue is resolved
  40 #        in the Jenkins environment: https://github.com/jorisroovers/gitlint/issues/535
  41 #    pre-commit run gitlint-ci --hook-stage manual
  42
  43 [testenv:gitlint]
  44 basepython = python3
  45 deps = gitlint
  46 commands =
  47     gitlint