test_changed_notebooks.yml

# This workflows executes new or modified example notebooks.

name: test_changed_notebooks

defaults:
  run:
    shell: bash  # To override PowerShell on Windows

on:
  # Trigger the workflow on push or PR to any branch
  push:
    paths:
      - 'doc/source/examples/**/*.ipynb'
  pull_request:
    paths:
      - 'doc/source/examples/**/*.ipynb'
    # don't trigger for draft PRs
    types: [ opened, synchronize, reopened, ready_for_review ]
  # Trigger the workflow on manual dispatch
  workflow_dispatch:

jobs:
  test_changed_notebooks:
    if: github.event.pull_request.draft == false

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
        include: # Run windows tests on only one python version
          - os: windows-latest
            python-version:  '3.11'

    steps:
      - name: Checkout code
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Check for new or changed .ipynb files
        id: changed-ipynb
        uses: tj-actions/changed-files@v1.1.2
        with:
          files: |
            doc/source/examples/*.ipynb

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip setuptools wheel
          python -m pip install --upgrade --upgrade-strategy eager -r requirements/dev.txt -r testing/requirements.txt
          python -m pip install --upgrade --upgrade-strategy eager .[shap,tensorflow]
          if [ "$RUNNER_OS" != "Windows" ]; then  
          # Windows support for ray is experimental (https://docs.ray.io/en/latest/installation.html#windows-support)
            python -m pip install --upgrade --upgrade-strategy eager .[shap,tensorflow,ray]
          fi
          python -m spacy download en_core_web_md
          python -m pip freeze

      - name: Run notebooks
        env:
          FILES: ${{ steps.changed-ipynb.outputs.all_modified_files }}
        # The following line builds the test case string to be passed to pytest by stripping the directory 'doc/source/examples/',
        # adding the `or` quantifier between the names and concatenating with the test name `test_notebook_execution`.
        run: |
          tests="test_notebook_execution[$(echo ${FILES} | sed 's|doc/source/examples/||g' | sed 's| | or |g')]" &&
          pytest --suppress-no-test-exit-code --no-cov -rA --durations=0 -vv testing/test_notebooks.py -k "$tests"