run_demos_tutorials.yml

name: Run splink_demos tutorial notebooks

on:
  pull_request:
    branches:
      - master
    paths:
      - splink/**
      - docs/demos/tutorials/**
      - pyproject.toml

  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9"]
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -- save a few section by caching poetry --
      #----------------------------------------------
      - name: Load cached Poetry installation
        uses: actions/cache@v2
        with:
          path: ~/.local # the path depends on the OS
          key: poetry-0 # increment to reset cache
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: '1.7.0'
          virtualenvs-create: true
          virtualenvs-in-project: true
          installer-parallel: true

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v2
        with:
          path: .venv
          key: venv-demos-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}-00
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction
      #----------------------------------------------
      #       pip install additional requirements
      #----------------------------------------------
      - name: Install additional requirements from demos_requirements.txt
        run: |
          poetry run pip install -r docs/demos/data/demos_requirements.txt
      #----------------------------------------------
      # Modify the notebooks to reduce the amount of data processed and speed up the tests
      #----------------------------------------------
      - name: Modify Notebooks to reduce data size
        run: |
          python scripts/reduce_notebook_runtime.py
      #----------------------------------------------
      # Make sure that the demo notebooks run without error
      #----------------------------------------------
      - name: Test with pytest
        run: |
          source .venv/bin/activate
          python -m pytest --nbmake -n=auto --nbmake-kernel=python3 docs/demos/tutorials/*ipynb