build: Deploy from main to pages

This commit is contained in:
Severin 2024-02-28 07:15:55 +01:00
parent e092f49ce5
commit 14c2846880
2 changed files with 70 additions and 1 deletions

View file

@ -0,0 +1,69 @@
name: deploy-book
# Based on:
# https://jupyterbook.org/en/stable/publish/gh-pages.html
# Run this when the master or main branch changes, or when dispatched
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/**
workflow_dispatch:
# 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
- 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@v3
with:
path: _build/.jupyter_cache
key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
# 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
permissions:
contents: read
pages: write
id-token: write

View file

@ -17,7 +17,7 @@ docutils==0.17.1
# now list the packages (and the respective url) you wish to download from the GitLab package registry
# toml file is here: https://gitlab.tudelft.nl/interactivetextbooks-citg/extensions/tud-citg-jb-stack/-/blob/main/pyproject.toml?ref_type=heads
--index-url https://__token__:glpat-JduurUdhDczFJzvzZN4G@gitlab.tudelft.nl/api/v4/projects/13957/packages/pypi/simple
--index-url https://gitlab.tudelft.nl/api/v4/projects/13957/packages/pypi/simple
citg-jb-stack
--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple
jupyterbook_patches ~= 0.1.3