name: Deploy docs (mdBook to GitHub Pages)
on:
push:
branches: [ main, master ]
workflow_dispatch: {}
jobs:
build-and-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python (required by preprocessor)
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Set up Rust toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
override: true
- name: Install mdBook
run: |
cargo install mdbook --version 0.5.2 --force
- name: Build mdBook (spec/)
working-directory: spec
run: |
mdbook build
- name: Deploy to GitHub Pages (gh-pages branch)
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./spec/book
publish_branch: gh-pages
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com