Skip to content

[GithubActions] Adding BASE_URL #31

[GithubActions] Adding BASE_URL

[GithubActions] Adding BASE_URL #31

# This is a basic workflow to help you get started with Actions
name: Jupyter Book
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# https://github.com/actions/starter-workflows/blob/55eb18560f57898549b12afa6defe7cc79705d6a/pages/static.yml#L13
permissions:
contents: read
pages: write
id-token: write
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
# Runs a set of commands using the runners shell
# https://mystmd.org/guide/deployment-github-pages#fn-except-custom-domains
- name: Install dependencies and build page
run: |
python -m pip install jupyter-book --pre
export BASE_URL="https://marinholab.github.io/OpenExecutableBooksRobotics/"
python -m jupyter book build --html --execute
# https://jupyterbook.org/en/stable/publish/gh-pages.html
# Upload the book's HTML as an artifact
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "_build/html"
# https://github.com/actions/deploy-pages/issues/305
- name: Configure Pages
uses: actions/configure-pages@v4
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4