CI_CD_actions.yml

name: Tests

on:
  push:
    tags:
      - v**
    branches-ignore:
      - "dependabot/**"
      - "sourcery/**"
      - "pre-commit-ci-update-config"
  pull_request:

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repo
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Run pre-commit
        uses: pre-commit/action@v3.0.1

  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup conda
        uses: s-weigand/setup-conda@v1
        with:
          conda-channels: conda-forge
          activate-conda: false
      - name: Set up Python 3.10
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install dependencies
        run: |
          conda install -y pandoc
          python -m pip install -U pip wheel
          python -m pip install -U pip wheel
          python -m pip install .[docs]
      - name: Show installed packages
        run: pip freeze
      - name: Build docs
        run: |
          make --directory=docs clean html

  docs-links:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup conda
        uses: s-weigand/setup-conda@v1
        with:
          conda-channels: conda-forge
          activate-conda: false
      - name: Set up Python 3.10
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install dependencies
        run: |
          conda install -y pandoc
          python -m pip install -U pip wheel
          python -m pip install .[docs]
      - name: Show installed packages
        run: pip freeze
      - name: Check doc links
        run: |
          make --directory=docs clean linkcheck "$@" | tee linkcheck-output.txt
          exit "${PIPESTATUS[0]}"
      - name: Linkcheck summary
        if: ${{ always() }}
        run: grep -E "(\(line.*\)|writing output)" < linkcheck-output.txt

  docs-notebooks:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.10
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install dependencies
        run: |
          python -m pip install -U pip wheel
          python -m pip install -U -r requirements_pinned.txt
          python -m pip install .[docs]
      - name: Show installed packages
        run: python -m pip freeze
      - name: Build docs
        run: |
          python -m pytest -vv --nbval docs/source/notebooks

  test:
    runs-on: ${{ matrix.os }}
    needs: [pre-commit]
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
        python-version: ["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: |
          python -m pip install --upgrade pip wheel
          python -m pip install -U -r requirements_pinned.txt
          python -m pip install ".[test]"
      - name: Show installed packages
        run: python -m pip freeze
      - name: Run tests
        run: |
          python -m pytest --cov=./ --cov-report term --cov-report xml --cov-config pyproject.toml tests

      - name: Codecov Upload
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.xml
          token: ${{ secrets.CODECOV_TOKEN }}

  deploy:
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    needs: [test, docs, docs-notebooks]
    permissions:
      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.10
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install dependencies
        run: python -m pip install -U hatch

      - name: Build dist
        run: hatch build

      - name: Publish package
        uses: pypa/gh-action-pypi-publish@v1.9.0
        with:
          print-hash: true