8444cc3deb
Problem: "deploy docs" always pulls in the `latest` release of `mdbook`, which now is a v0.5.0 prerelease with breaking changes -- including removing an (apparently unused) `multilingual` config field in the TOML that is now an error (another breaking change). Solution: Delete the line. Add `workflow_dispatch` to the docs workflow in case follow-up changes are needed; see https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide
50 lines
1.2 KiB
YAML
50 lines
1.2 KiB
YAML
name: Deploy Docs
|
|
on:
|
|
push:
|
|
branches: [master]
|
|
paths: [docs/**]
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
deploy-docs:
|
|
runs-on: ubuntu-latest
|
|
|
|
permissions:
|
|
contents: write
|
|
pages: write
|
|
id-token: write
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Set up Rust
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1
|
|
|
|
- name: Install mdbook
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
run: |
|
|
jq_expr='.assets[] | select(.name | contains("x86_64-unknown-linux-gnu")) | .browser_download_url'
|
|
url=$(gh api repos/rust-lang/mdbook/releases/latest --jq "$jq_expr")
|
|
mkdir mdbook
|
|
curl -sSL "$url" | tar -xz -C mdbook
|
|
printf '%s/mdbook\n' "$PWD" >> "$GITHUB_PATH"
|
|
|
|
- name: Install mdbook-admonish
|
|
run: cargo install mdbook-admonish
|
|
|
|
- name: Build Book
|
|
run: mdbook build docs
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v5
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v4
|
|
with:
|
|
path: docs/book
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|