name: Docs

on:
  push:
    branches: [main]
    tags: ["v*.*.*"]
  pull_request:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read

jobs:
  build:
    name: Build mdbook
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install mdbook
        run: |
          mkdir -p ~/.local/bin
          curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-musl.tar.gz" \
            | tar -xz -C ~/.local/bin
          echo "$HOME/.local/bin" >> "$GITHUB_PATH"
      - name: Build
        run: |
          cd docs/book
          mdbook build
      - name: Upload book as artifact
        uses: actions/upload-artifact@v4
        with:
          name: book
          path: target/book
          if-no-files-found: error
          retention-days: 14

  # GitHub Pages deployment is intentionally not in this workflow.
  # Once Pages is enabled on the repo (Settings → Pages → Build and
  # deployment: GitHub Actions), this file can grow a `deploy` job
  # using actions/configure-pages + actions/deploy-pages.