github_test_action.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: simbench

on:
  push:
    branches: '*'
    paths-ignore:
      - 'CHANGELOG.rst'
  pull_request:
    branches: '*'
    paths-ignore:
      - 'CHANGELOG.rst'

jobs:

  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12']
        # Reminder: when removing support of an old python version here, then don't forget to remove
        # it also in pyproject.toml 'requires-python'
    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
        python -m pip install pytest jupyter
        python -m pip install $GITHUB_WORKSPACE["test"]
    - name: List of installed packages
      run: |
        python -m pip list
    - name: Test with pytest
      if: ${{ matrix.python-version != '3.9' }}
      run: |
        pytest
    - name: Test with pytest and Codecov
      if: ${{ matrix.python-version == '3.9' }}
      run: |
        pip install pytest-cov
        pytest --cov=./ --cov-report=xml
    - name: Upload coverage to Codecov
      if: ${{ matrix.python-version == '3.9' }}
      uses: codecov/codecov-action@v1
      with:
        verbose: true

  warnings:

    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install $GITHUB_WORKSPACE["test"]
    - name: List of installed packages
      run: |
        python -m pip list
    - name: Test with pytest
      run: |
        pytest -W error

  tutorial_tests:

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install $GITHUB_WORKSPACE["all"]
      - name: List of installed packages
        run: |
          python -m pip list
      - name: Test with pytest
        run: |
          PYTHONPATH=$PYTHONPATH:$GITHUB_WORKSPACE python -m pytest --nbmake -n=auto --nbmake-timeout=900 "./tutorials"

  tutorial_warnings_tests:

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install $GITHUB_WORKSPACE["all"]
      - name: List of installed packages
        run: |
          python -m pip list
      - name: Test with pytest
        run: |
          PYTHONPATH=$PYTHONPATH:$GITHUB_WORKSPACE python -m pytest -W error --nbmake -n=auto --nbmake-timeout=900 "./tutorials"

  docs_check:
    needs: build
    name: Sphinx docs check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check sphinx build
        uses: ammaraskar/sphinx-action@7.4.7
        with:
          pre-build-command: "python -m pip install uv && uv pip install .[docs] --system --link-mode=copy"
          build-command: "sphinx-build -b html . _build -W"
          docs-folder: "doc/"