Skip to content

review all notebooks are functioning correctly #219

review all notebooks are functioning correctly

review all notebooks are functioning correctly #219

Workflow file for this run

name: deploy-book
# Run this when the master or main branch changes
on:
push:
branches:
- main
- development
pull_request:
branches:
- development
- main
# If your git repository has the Jupyter Book within some-subfolder next to
# unrelated files, you can make this run only if a file within that specific
# folder has been modified.
#
# paths:
# - some-subfolder/**
# This job installs dependencies, builds the book, and pushes it to `gh-pages`
jobs:
deploy-book:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write
steps:
- uses: actions/checkout@v3
# Install dependencies
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
run: |
pip install .[books]
# (optional) Cache your executed notebooks between runs
# if you have config:
# execute:
# execute_notebooks: cache
- name: cache executed notebooks
uses: actions/cache@v3
with:
path: _build/.jupyter_cache
key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
# Build the book
- name: Build the book
run: |
jupyter-book build tutorials
# Deploy to gh-pages using peaceiris action for all branches
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: tutorials/_build/html
publish_branch: gh-pages
destination_dir: ${{ github.ref == 'refs/heads/main' && '.' || 'dev-preview' }}
keep_files: ${{ github.ref != 'refs/heads/main' }}