GitHub Actions
A powerful CI/CD platform built into GitHub for automating workflows: testing, linting, type-checking, and more.
What is it used for here?
!
- Automatically runs linters, tests, and checks code quality for every push and pull request
- Ensures your code works on multiple Python versions
- Checks code compatibility with the minimum Python version using Vermin
- Runs all key quality tools: Ruff, MyPy, Pytest, and more
How does it work in this template?
- Workflow files are located in
.github/workflows/. - Actions are triggered automatically on push or pull request to key branches.
- Each workflow installs only used dependencies using default
pip. - Main scenarios covered:
Example workflows
Common workflow: Lint, Typecheck, Test
.github/workflows/code-quality.yml
name: Lint, Typecheck, Test
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: uv pip install -r requirements-dev.txt
- name: Lint
run: uv run ruff check ./src/
- name: Typecheck
run: uv run mypy ./src/
- name: Test
run: uv run pytest -v
Compatibility check: Vermin
See Vermin section for details.
How to add or edit workflows
- All workflow YAML files are in
.github/workflows/ - To add a new workflow, just copy an existing
.ymlfile and edit as needed.
Configuration and secrets
- No sensitive secrets are used by default in this template.
- For advanced scenarios (e.g., publishing, deploying), add secrets in GitHub repo settings and reference via
${{ secrets.YOUR_SECRET }}.
For more details, see the GitHub Actions Documentation.