Skip to content

Commit

Permalink
gh action deploy-book
Browse files Browse the repository at this point in the history
  • Loading branch information
coobas committed Sep 30, 2024
1 parent 5d216f9 commit 4f880cc
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: deploy-book

# Run this when the master or main branch changes
on:
push:
branches:
- jupyter-book
- 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@v3

# Install dependencies
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11

- uses: astral-sh/setup-uv@v1
with:
version: "latest"

- name: Install dependencies
run: |
uv sync
# (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: book/_build/.jupyter_cache
key: jupyter-book-cache-${{ hashFiles('uv.lock') }}

# Build the book
- name: Build the book
run: |
jupyter-book build book/
# Upload the book's HTML as an artifact
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "book/_build/html"

# Deploy the book's HTML to GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit 4f880cc

Please sign in to comment.