mirror of
https://github.com/bdbrown4/peltier.io.git
synced 2026-11-07 19:08:27 +00:00
56 lines
1.4 KiB
YAML
56 lines
1.4 KiB
YAML
name: docs
|
|
|
|
# Builds the mdBook site in docs/ and deploys it to GitHub Pages.
|
|
# One-time setup: repo Settings → Pages → Source = "GitHub Actions".
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- "docs/**"
|
|
- ".github/workflows/docs.yml"
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow one concurrent deployment; don't cancel an in-progress prod deploy.
|
|
concurrency:
|
|
group: pages
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
MDBOOK_VERSION: "0.4.40"
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Configure Pages
|
|
uses: actions/configure-pages@v5
|
|
- name: Install mdBook
|
|
run: |
|
|
mkdir -p "$HOME/.local/bin"
|
|
url="https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz"
|
|
curl -sSL "$url" | tar -xz -C "$HOME/.local/bin"
|
|
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
|
- name: Build
|
|
run: mdbook build docs
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: docs/book
|
|
|
|
deploy:
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|