ci.yml

name: CI
on:
  pull_request:
  push:
    branches:
      - main

# Cancel active CI runs for a PR before starting another run
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash  # https://github.com/beeware/briefcase/pull/912

env:
  FORCE_COLOR: "1"

jobs:
  pre-commit:
    name: Pre-commit checks
    uses: beeware/.github/.github/workflows/pre-commit-run.yml@main
    with:
      pre-commit-source: "--group pre-commit"

  lint:
    needs: [ pre-commit ]
    runs-on: ubuntu-latest
    timeout-minutes: 5
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.0
        with:
          fetch-depth: 1

      - name: Set up Python
        uses: actions/setup-python@v6.3.0
        with:
          python-version: "3.X"
          cache: pip
          cache-dependency-path: |
            pyproject.toml
            .pre-commit-config.yaml

      - name: Install system dependencies
        run: |
          sudo apt-get install aspell aspell-en

      - name: Update pip
        run: python -m pip install -U pip

      - name: Install Tox
        run: python -m pip install --group 'tox-uv'

      - name: Perform lint checks
        run: python -m tox -e docs-lint

  unit-tests:
    name: Unit tests
    needs: [ pre-commit ]
    runs-on: ubuntu-24.04
    continue-on-error: false
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.0
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v6.3.0
        with:
          python-version: 3.12

      - name: Install Tox
        run: python -m pip install --group tox-uv

      - name: Test
        id: test
        run: |
          tox -e py