ci.yml

name: GitHub CI

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  docs-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 10
      - name: Verify git status
        run: |
          git status
          git remote -v
      - name: Set up Python 3.12
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Install build dependencies
        run: |
          pip install -r requirements.txt
      - name: Install docs dependencies
        run: |
          pip install Sphinx -r docs/requirements.txt
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Check docs
        run: |
          pushd docs
          # -W for turn warnings into errors
          # --keep-going to not abort on first error
          # -n for nitpicky
          make html SPHINXOPTS="-W --keep-going -n"
  code-format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 10
      - name: Verify git status
        run: |
          git status
          git remote -v
      - name: Set up Python 3.12
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Install build dependencies
        run: |
          pip install -r requirements.txt
      - name: Install black
        run: |
          pip install black==24.4.2
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Check formatting
        run: |
          black --check --line-length 79 .

  test:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: py3.9
            os: ubuntu-latest
            python-version: "3.9"
          - name: py3.10
            os: ubuntu-latest
            python-version: "3.10"
          - name: py3.11
            os: ubuntu-latest
            python-version: "3.11"
          - name: py3.12
            os: ubuntu-latest
            python-version: "3.12"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 10
      - name: Verify git status
        run: |
          git status
          git remote -v
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Install pytest
        run: |
          pip install pytest
      - name: Install build dependencies
        run: |
          pip install -r requirements.txt
      - name: Display installed python package versions
        run: |
          pip list || :
      - name: Run unit tests
        run: |
          pytest

  coveralls:
    runs-on: ubuntu-latest
    steps:

    - uses: actions/checkout@v4

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

    - name: Display Python version
      run: python -c "import sys; print(sys.version)"
    
    - name: Display installed python package versions
      run: |
        pip list || :
    
    - name: Install coverage
      run: |
        pip install coverage
    
    - name: Install build dependencies
      run: |
        pip install -r requirements.txt
    
    - name: Display installed python package versions
      run: |
        pip list || :

    - name: Run unit tests with coverage
      run: |
        coverage run -m pytest
  
    - name: Report Coveralls
      run: curl -sL https://coveralls.io/coveralls-linux.tar.gz | tar -xz && ./coveralls
      env:
        COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}