Skip to content

Deploy mdBook site to Pages #3

Deploy mdBook site to Pages

Deploy mdBook site to Pages #3

Workflow file for this run

name: Deploy mdBook site to Pages
on:
# Runs on pushes targeting the default branch, when touching the book
push:
branches: [$default-branch]
paths:
- 'book/**'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
MDBOOK_VERSION: 0.4.40
MDBOOK_KATEX_VERSION: 0.9.0
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- name: Install mdBook
run: |
cargo install --version ${MDBOOK_VERSION} mdbook
- name: Install mdBook-katex
run: |
cargo install --version ${MDBOOK_KATEX_VERSION} mdbook-katex
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with mdBook
run: cd book && mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./book/book
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4