ci.yml

name: Test and build

on: [push, pull_request, release]

jobs:
  check-links:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: gaurav-nelson/github-action-markdown-link-check@v1
        name: Check links in markdown files
        with:
          use-quiet-mode: "yes"
          use-verbose-mode: "yes"

  test:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [windows-latest, ubuntu-latest, macos-latest]
        python-version: ["3.11"]

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install system dependencies in Linux
        if: matrix.os == 'ubuntu-latest'
        run: |
          sudo apt update

          # Without this, PySide6 gives an ImportError
          sudo apt install libegl1

      - name: Install Poetry
        uses: abatilo/actions-poetry@v2.3.0
        with:
          poetry-version: 1.2.2

      - name: Install dependencies
        run: poetry install

      - name: Run tests
        run: poetry run pytest --cov-report=xml
        env:
          QT_QPA_PLATFORM: offscreen

      - name: Upload coverage to Codecov
        if: matrix.os == 'ubuntu-latest' && success()
        uses: codecov/codecov-action@v3

      - name: Check for documentation errors with MkDocs
        run: |
          poetry run mkdocs build -s

      - name: Build package
        if: matrix.os == 'windows-latest'
        run: poetry run pyinstaller FINESSE.spec

      - uses: actions/upload-artifact@v3
        if: success() && matrix.os == 'windows-latest'
        with:
          name: FINESSE
          path: dist/FINESSE.exe

      - name: Upload release artifacts
        if: startsWith(github.ref, 'refs/tags/') && matrix.os == 'windows-latest'
        uses: softprops/action-gh-release@v1
        with:
          files: dist/FINESSE.exe

  docs:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v4
        with:
          python-version: "3.11"

      - name: Install system dependencies in Linux
        run: |
          sudo apt update

          # Without this, PySide6 gives an ImportError
          sudo apt install libegl1

      - name: Install Poetry
        uses: abatilo/actions-poetry@v2.3.0
        with:
          poetry-version: 1.2.2

      - name: Install dependencies
        run: poetry install

      - name: Deploy Docs
        run: poetry run mkdocs gh-deploy --force