ci.yml

name: Auto Testing

on:
  pull_request:
  push:
    branches: ["master"]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:

  tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run:
          pip install .[tests]

      - name: Run Unit Tests with Coverage
        run: |
          coverage run -m pytest -vv
          coverage report -m
          coverage html

      - name: Upload Coverage HTML report to Artifacts
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: coverage-report-${{matrix.python-version}}
          path: htmlcov/

  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v2

      - name: build output
        run: pipx run nox -s docs
        working-directory: ./

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: docs/build

  deploy:
    needs:
      - docs
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1