Skip to content

change deployment script to suggestion from Jupyter Book documentation #28

change deployment script to suggestion from Jupyter Book documentation

change deployment script to suggestion from Jupyter Book documentation #28

Workflow file for this run

name: deploy-book
# Run this when the master or main branch changes
on:
push:
branches:
- master
- 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:
pages: write
id-token: write
steps:
- uses: actions/checkout@v5
# Install dependencies
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
cache: pip # Implicitly uses requirements.txt for cache key
- name: Install dependencies
run: pip install -r requirements.txt
# (optional) Cache your executed notebooks between runs
# if you have config:
# execute:
# execute_notebooks: cache
- name: cache executed notebooks
uses: actions/cache@v4
with:
path: _build/.jupyter_cache
key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
# Build the book
- name: Build the book
run: |
jupyter-book build .
# https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow
# Upload the book's HTML as an artifact
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: _build/html
# Deploy the book's HTML to GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4