pyscal.yml

name: pyscal

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  release:
    types:
      - published
  schedule:
    # Run CI every night and check that tests are working with latest dependencies
    - cron: "0 0 * * *"

env:
  # Default python version to be use to create docs
  DEFAULT_PYTHON_VERSION: "3.12"
  UV_SYSTEM_PYTHON: 1

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  pyscal:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        python-version: ["3.11", "3.12", "3.13", "3.14"]
        os: ["ubuntu-latest"]
        pandas-version: [""]
        include:
          - os: "macos-latest"
            python-version: "3.13"
          - os: "windows-latest"
            python-version: "3.13"
          - python-version: "3.13"
            pandas-version: ">=2,<3"
            os: "ubuntu-latest"
          - python-version: "3.13"
            pandas-version: ">=3.0.0"
            os: "ubuntu-latest"
        exclude:
          - python-version: "3.13"
            pandas-version: ""

    steps:
      - name: Checkout commit locally
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

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

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true
          python-version: ${{ matrix.python-version }}

      - name: Install pyscal with dependencies
        if: ${{ always() }}
        run: |
          uv pip install ".[tests, docs]"

      - name: Install opm and res2df
        if: matrix.python-version == '3.13' && matrix.os == 'ubuntu-latest'
        run: |
          # for extra tests
          uv pip install opm res2df

      - name: Pin pandas version
        if: matrix.pandas-version
        run: uv pip install "pandas${{ matrix.pandas-version }}"

      - name: List all installed packages
        if: ${{ always() }}
        run: uv pip freeze

      - name: Linting using pre-commit
        if: ${{ always() }}
        run: |
          pre-commit run --all-files --show-diff-on-failure

      - name: Check typing with mypy
        if: ${{ always() }}
        run: |
          mypy src/pyscal

      - name: Run tests
        if: ${{ always() }}
        run: |
          python -c "import pyscal"
          pytest -n auto --strict-markers --hypothesis-profile ci tests/

      - name: Install font (xkcd) for documentation
        if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == env.DEFAULT_PYTHON_VERSION }}
        run: |
          sudo apt-get install -y fonts-humor-sans

      - name: Build documentation
        if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == env.DEFAULT_PYTHON_VERSION }}
        run: |
          python docs/make_plots.py
          sphinx-build -b html docs ./build/sphinx/html

      - name: Update GitHub pages
        if: ${{ github.event_name == 'release' && matrix.os == 'ubuntu-latest' && matrix.python-version == env.DEFAULT_PYTHON_VERSION }}
        run: |
          cp -R ./build/sphinx/html ../html

          git config --local user.email "pyscal-github-action"
          git config --local user.name "pyscal-github-action"
          git fetch origin gh-pages
          git stash  # Due to make_plots.py above maybe having modified png files
          git checkout --track origin/gh-pages
          git clean -f -f -d -x  # Double -f is intentional
          git rm -r *

          cp -R ../html/* .

          git add .

          if git diff-index --quiet HEAD; then
            echo "No changes in documentation. Skip documentation deploy."
          else
            git commit -m "Update Github Pages"
            git push "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" gh-pages
          fi