book.yml

# Originally copied from https://github.com/leptos-rs/book/blob/f6683d42f2a9f67230cfdf9fb94e094f1c8bfca4/.github/workflows/publish_mdbook.yml#L1

name: Book

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

  # 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

env:
  MDBOOK_VERSION: 0.4.40

jobs:
  test-book:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: rui314/setup-mold@v1
      - uses: Swatinem/rust-cache@v2
      - uses: taiki-e/install-action@mdbook
      - uses: taiki-e/install-action@just

      - name: Test mdbook
        run: just test-book

      - name: Test mdbook examples
        run: just test-book-examples

  build-and-deploy-book:
    # Only deploy on pushes to `main` or manual workflow dispatches
    if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
    needs: test-book
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - uses: taiki-e/install-action@mdbook

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5

      - name: Build
        run: mdbook build book

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./book/book

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4