test_doc.yml

name: "Test and deploy"

on:
  push:
    branches: [ main ]

jobs:

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

    steps:
    - name: Checkout 🛎️
      uses: actions/checkout@v4

    - name: Set up Python ${{ matrix.python-version }} 🔧
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
        cache: 'pip'
        cache-dependency-path: setup.py

    - name: Install dependencies 🔧
      run: |
        python -m pip install --upgrade pip
        pip install -e .['full']

    - name: Test with pytest 🔧
      run: |
        pytest --cov=./ --cov-report=xml -v

    - name: Run codecov 🔧
      run: |
        codecov

    - name: Upload coverage to Codecov 🚀
      uses: codecov/codecov-action@v4
      with:
        directory: ./coverage/reports/
        env_vars: OS,PYTHON
        fail_ci_if_error: true
        files: ./coverage.xml
        flags: unittests
        name: codecov-umbrella
        token: ${{ secrets.CODECOV_TOKEN }}
        verbose: true

  deploy:
    needs: test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4

      - name: Set up Python 🔧
        uses: actions/setup-python@v5
        with:
          python-version: '3.9'

      - name: Install dependencies 🔧
        run: |
          python -m pip install --upgrade pip
          pip install -e .['doc']

      - name: Build the Doc 🔧
        run: |
          cd docs
          make clean
          make html
          touch _build/html/.nojekyll

      - name: Deploy Github Pages 🚀
        uses: JamesIves/github-pages-deploy-action@v4.6.4
        with:
          branch: gh-pages
          folder: docs/_build/html/
          clean: true
          ssh-key: ${{ secrets.DEPLOY_KEY }}