Skip to content

🎬 GitHub Actions

This project uses GitHub Actions to automate some boring tasks.

You can find all the workflows in the .github/workflows directory.

🎢 Workflows

Name Description & Status Triggered on
Deploy API Documentation Deploys API documentation to GitHub Pages.

Deploy API Documentation		 push on main, alpha and workflow_dispatch
Docker Builds and pushes Docker images for the project.

Docker		 pull_request on main, alpha and push on main, alpha and workflow_dispatch
Lint Runs linting checks using pre-commit hooks.

Lint		 push
Package Packages the project and publishes it to PyPI and GitHub Releases.

Package		 push on main, alpha
Renovate Runs Renovate to update dependencies.

Renovate		 schedule and workflow_dispatch
Security Checks Performs security checks using pip-audit.

Security Checks		 workflow_dispatch and push
Test Runs unit tests and generates coverage reports.

Test		 push
Update Badges Updates badges.yaml with test results and coverage.

Update Badges		 workflow_run (completed)