test.yml

---
name: Test

on:
  push:
    branches:
      - main
  pull_request:
    # ensure the draft PRs are tested when ready
    types:
      - opened
      - ready_for_review
      - reopened
      - synchronize

concurrency:
  # Skip intermediate builds: always.
  # Cancel intermediate builds: only if it is a pull request build.
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

env:
  # The "FORCE_COLOR" variable, when set to 1,
  # tells Nox to colorize itself.
  FORCE_COLOR: "1"

jobs:
  tests:
    name: Tests
    if: github.event.pull_request.draft == false
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - "3.8"
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Run doctests
        run:
          pipx run nox -s doctests-${{ matrix.python-version.key ||
          matrix.python-version }} --verbose
      - name: Run tests and generate coverage report
        run:
          pipx run nox -s tests-${{ matrix.python-version.key ||
          matrix.python-version }} --verbose
      - name: Coveralls requires coverage.py
        run: |
          pip install coverage[toml]
          coverage xml
      - uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          debug: true
          fail-on-error: true

  build:
    name: Build
    if: github.event.pull_request.draft == false
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Build SDist and wheel
        run: pipx run nox -s build --verbose

  docs:
    name: Docs
    if: github.event.pull_request.draft == false
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install pandoc
      - name: Build docs
        run: pipx run nox -s docs --verbose