test.yml

name: Tests

on:
  push:
    branches:
      - main
    tags:
      - 'v[0-9]+.[0-9]+.[0-9]+'
  pull_request:
    branches:
      - main
  workflow_dispatch: {}

concurrency:
  group: ${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  unit_tests:
    name: Unit testing
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12"]
    steps:
        - name: Checkout main code and submodules
          uses: actions/checkout@v4
        - name: Set up Python ${{ matrix.python-version }}
          uses: actions/setup-python@v5
          with:
            python-version: ${{ matrix.python-version }}
        - name: Install hatch
          run: |
            pip install --upgrade pip
            pip install hatch
        - name: Install main dependencies in test env
          run: |
            hatch -v -e tests
        - name: Perform unit tests
          run: |
            hatch -e tests run pytest -n auto

  test_docs:
    name: Documentation
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
        - name: Checkout main code and submodules
          uses: actions/checkout@v4
        - name: Set up Python ${{ matrix.python-version }}
          uses: actions/setup-python@v5
          with:
            python-version: ${{ matrix.python-version }}
        - name: Install hatch
          run: |
            pip install --upgrade pip
            pip install hatch
        - name: Install main dependencies
          run: |
            hatch -v -e docs
        - name: Test docs
          run: |
            hatch run docs:build

  publish:
    name: Publish to PyPI
    if: startsWith(github.ref, 'refs/tags/v')
    needs: unit_tests
    runs-on: ubuntu-latest
    permissions:
      # IMPORTANT: this permission is mandatory for trusted publishing
      id-token: write
    steps:
      - name: Checkout main code
        uses: actions/checkout@v4
        with:
          ref: ${{ github.ref }}
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install Python dependencies
        run: |
          pip install --upgrade pip
          pip install hatch
      - name: Build package
        run: |
          hatch build
      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
      - name: Confirm deployment
        timeout-minutes: 5
        run: |
          VERSION=${GITHUB_REF#refs/tags/v}
          until pip download pyqtorch==$VERSION
          do
            echo "Failed to download from PyPI, will wait for upload and retry."
            sleep 1
          done

  deploy_docs:
    name: Deploy documentation
    if: startsWith(github.ref, 'refs/tags/v')
    needs: [unit_tests, test_docs]
    runs-on: ubuntu-latest
    steps:
    - name: Checkout main code
      uses: actions/checkout@v4
    - name: Install JetBrains Mono font
      run: |
        sudo apt install -y wget unzip fontconfig
        wget https://download.jetbrains.com/fonts/JetBrainsMono-2.304.zip
        unzip JetBrainsMono-2.304.zip -d JetBrainsMono
        mkdir -p /usr/share/fonts/truetype/jetbrains
        cp JetBrainsMono/fonts/ttf/*.ttf /usr/share/fonts/truetype/jetbrains/
        fc-cache -f -v
    - name: Install graphviz
      run: sudo apt-get install -y graphviz
    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
    - name: Install Hatch
      run: |
        pip install --upgrade pip
        pip install hatch
    - name: Deploy docs
      run: |
        git config user.name "GitHub Actions"
        git config user.email "actions@github.com"
        git fetch origin gh-pages
        hatch -v run docs:mike deploy --push --update-aliases ${{ github.ref_name }} latest