Skip to content

docs: comprehensive documentation audit and improvements #2142

docs: comprehensive documentation audit and improvements

docs: comprehensive documentation audit and improvements #2142

Workflow file for this run

name: Lint
on:
pull_request:
branches: [main, "release/*"]
push:
branches: [main, "release/*"]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
lint:
runs-on: windows-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v4
- name: Set up Python
run: uv python install 3.11
- name: Install dependencies
run: uv sync --all-extras
- name: Check license headers
run: |
uv run pre-commit run insert-license --all-files
- name: Lint
run: uv run ruff check src/ tests/
# Type-checking is currently advisory: src/ has many pre-existing
# mypy errors against the strict config in pyproject.toml. The job
# surfaces type issues in CI logs without blocking PRs while the
# backlog is worked down. Flip continue-on-error to false (or drop
# it) once src/ is clean.
- name: Type check (advisory)
continue-on-error: true
run: uv run mypy -p winml.modelkit