Initialize Jupyter Book (#3) #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions | |
name: deploy-book | |
# Only run this when the main branch changes | |
on: | |
# Uncomment the 'pull_request' line below to manually re-build Jupyter Book | |
# pull_request: | |
push: | |
branches: | |
- 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: | |
- '.github/workflows/deploy-book.yml' | |
- 'book/**' | |
# 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 | |
defaults: | |
run: | |
shell: bash -l {0} | |
steps: | |
# Checkout current git repository | |
- name: Checkout | |
uses: actions/[email protected] | |
# Install Mambaforge with conda-forge dependencies | |
- name: Setup Mambaforge | |
uses: mamba-org/[email protected] | |
with: | |
environment-name: agu24workshop | |
environment-file: conda-lock.yml | |
create-args: >- | |
python=${{ matrix.python-version }} | |
condarc: | | |
channels: | |
- conda-forge | |
- nodefaults | |
# Build the book | |
- name: Build the book | |
run: jupyter-book build book/ | |
# Push the book's HTML to github-pages | |
- name: GitHub Pages action | |
uses: peaceiris/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: book/_build/html |