mirror of
https://github.com/arcan1s/ahriman.git
synced 2025-06-28 06:41:43 +00:00
Evgenii Alekseev
066d1b1dde
This commit includes the following changes * Bump github actions * Update tests github action to check documentation and streamline process * Update test cases to use temporary directories as roots * Simplify tox.ini
124 lines
4.0 KiB
INI
124 lines
4.0 KiB
INI
[tox]
|
|
envlist = check, tests
|
|
isolated_build = true
|
|
labels =
|
|
release = version, docs, publish
|
|
dependencies = -e .[journald,pacman,reports,s3,shell,stats,unixsocket,validator,web,web_api-docs,web_auth,web_oauth2,web_metrics]
|
|
project_name = ahriman
|
|
|
|
[flags]
|
|
autopep8 = --max-line-length 120 -aa --in-place
|
|
bandit = --configfile .bandit.yml
|
|
manpage = --author "ahriman team" --author-email "" --description "ArcH linux ReposItory MANager" --manual-title "ArcH linux ReposItory MANager" --project-name ahriman --url https://github.com/arcan1s/ahriman
|
|
mypy = --implicit-reexport --strict --allow-untyped-decorators --allow-subclassing-any
|
|
pydeps = --no-config --cluster
|
|
pylint = --rcfile .pylint.toml
|
|
shtab = --prefix ahriman --prog ahriman ahriman.application.ahriman._parser
|
|
|
|
[pytest]
|
|
addopts = --cov=ahriman --cov-report=term-missing:skip-covered --no-cov-on-fail --cov-fail-under=100 --spec
|
|
asyncio_default_fixture_loop_scope = function
|
|
asyncio_mode = auto
|
|
spec_test_format = {result} {docstring_summary}
|
|
|
|
[testenv:archive]
|
|
description = Create source files tarball
|
|
deps =
|
|
build
|
|
commands =
|
|
python -m build --sdist
|
|
|
|
[testenv:check]
|
|
description = Run common checks like linter, mypy, etc
|
|
dependency_groups =
|
|
check
|
|
deps =
|
|
{[tox]dependencies}
|
|
pip_pre = true
|
|
setenv =
|
|
CFLAGS="-Wno-unterminated-string-initialization"
|
|
MYPYPATH=src
|
|
commands =
|
|
autopep8 {[flags]autopep8} --exit-code --jobs 0 --recursive "src/{[tox]project_name}" "tests/{[tox]project_name}"
|
|
pylint {[flags]pylint} "src/{[tox]project_name}"
|
|
bandit {[flags]bandit} --recursive "src/{[tox]project_name}"
|
|
bandit {[flags]bandit} --skip B101,B105,B106 --recursive "tests/{[tox]project_name}"
|
|
mypy {[flags]mypy} --install-types --non-interactive --package "{[tox]project_name}"
|
|
|
|
[testenv:docs]
|
|
description = Generate source files for documentation
|
|
allowlist_externals =
|
|
bash
|
|
find
|
|
dependency_groups =
|
|
docs
|
|
depends =
|
|
version
|
|
deps =
|
|
{[tox]dependencies}
|
|
uv
|
|
pip_pre = true
|
|
setenv =
|
|
PYTHONPATH=src
|
|
SPHINX_APIDOC_OPTIONS=members,no-undoc-members,show-inheritance
|
|
commands =
|
|
bash -c 'shtab {[flags]shtab} --shell bash > package/share/bash-completion/completions/_ahriman'
|
|
bash -c 'shtab {[flags]shtab} --shell zsh > package/share/zsh/site-functions/_ahriman'
|
|
argparse-manpage {[flags]manpage} --module ahriman.application.ahriman --function _parser --output ../package/share/man/man1/ahriman.1
|
|
pydeps {[flags]pydeps} --no-output --show-dot --dot-output {tox_root}{/}docs/_static/architecture.dot src/ahriman
|
|
# remove autogenerated modules rst files
|
|
find docs -type f -name "{[tox]project_name}*.rst" -delete
|
|
sphinx-apidoc --output-dir docs src
|
|
# compile list of dependencies for rtd.io
|
|
uv pip compile --group pyproject.toml:docs --extra s3 --extra validator --extra web --output-file docs/requirements.txt --quiet pyproject.toml
|
|
|
|
[testenv:html]
|
|
description = Generate html documentation
|
|
dependency_groups =
|
|
docs
|
|
deps =
|
|
{[tox]dependencies}
|
|
pip_pre = true
|
|
recreate = true
|
|
commands =
|
|
sphinx-build --builder html --write-all --jobs auto --fail-on-warning docs {envtmpdir}{/}html
|
|
|
|
[testenv:publish]
|
|
description = Create and publish release to GitHub
|
|
allowlist_externals =
|
|
git
|
|
depends =
|
|
docs
|
|
passenv =
|
|
SSH_AUTH_SOCK
|
|
commands =
|
|
git add package/archlinux/PKGBUILD src/ahriman/__init__.py docs/_static/architecture.dot package/share/man/man1/ahriman.1 package/share/bash-completion/completions/_ahriman package/share/zsh/site-functions/_ahriman
|
|
git commit -m "Release {posargs}"
|
|
git tag "{posargs}"
|
|
git push
|
|
git push --tags
|
|
|
|
[testenv:tests]
|
|
description = Run tests
|
|
dependency_groups =
|
|
tests
|
|
deps =
|
|
{[tox]dependencies}
|
|
pip_pre = true
|
|
setenv =
|
|
CFLAGS="-Wno-unterminated-string-initialization"
|
|
commands =
|
|
pytest {posargs}
|
|
|
|
[testenv:version]
|
|
description = Bump package version
|
|
allowlist_externals =
|
|
sed
|
|
deps =
|
|
packaging
|
|
commands =
|
|
# check if version is set and validate it
|
|
{envpython} -c 'from packaging.version import Version; Version("{posargs}")'
|
|
sed -i 's/^__version__ = .*/__version__ = "{posargs}"/' src/ahriman/__init__.py
|
|
sed -i "s/pkgver=.*/pkgver={posargs}/" package/archlinux/PKGBUILD
|