notebooks.yml

# This workflow is used to test, if the code is compatible with jupyter notebooks providing usage examples

name: Notebooks

on:
  push:
    branches: [ main ]
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Merge Notebook environment
        run: |
          cp binder/environment.yml environment.yml
          tail --lines=+4 .ci_support/environment-notebooks.yml >> environment.yml
          echo -e "channels:\n  - conda-forge\n" > .condarc
      - name: Setup Mambaforge
        uses: conda-incubator/setup-miniconda@v3
        with:
          python-version: "3.12"
          miniforge-version: latest
          condarc-file: .condarc
          environment-file: environment.yml
      - name: Install
        shell: bash -l {0}
        run: |
          pip install versioneer[toml]==0.29
          pip install . --no-deps --no-build-isolation
          mkdir config
          cp -r tests/config/flux config
      - name: Notebooks with config
        shell: bash -l {0}
        run: >
          flux start
          papermill notebooks/example_config.ipynb example-config-out.ipynb -k "python3"
      - name: Notebooks dynamic
        shell: bash -l {0}
        run: >
          flux start
          papermill notebooks/example_queue_type.ipynb example-queue-type-out.ipynb -k "python3"