mdBook.yml

name: Build mdBook Site & Deploy if Necessary

on:
  # Run on all pushes -- we check for only running on deploy later
  push:
  # 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

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    env:
      MDBOOK_VERSION: 0.4.21
      MDBOOK_ADMONISH_VERSION: 1.11.1
      MDBOOK_LINKCHECK_VERSION: 0.7.7
      MDBOOK_MERMAID_VERSION: 0.12.6
      MDBOOK_TEMPLATE_VERSION: 1.1.0
    steps:
      - uses: actions/checkout@v3
      - name: Install Rust
        run: |
          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
          rustup update
      - name: Install mdbook
        uses: taiki-e/cache-cargo-install-action@v1.2.1
        with:
          tool: mdbook@${MDBOOK_VERSION}
      - name: Install mdbook-admonish
        uses: taiki-e/cache-cargo-install-action@v1.2.1
        with:
          tool: mdbook-admonish@${MDBOOK_ADMONISH_VERSION}
      - name: Install mdbook-linkcache
        uses: taiki-e/cache-cargo-install-action@v1.2.1
        with:
          tool: mdbook-linkcheck@${MDBOOK_LINKCHECK_VERSION}
      - name: Install mdbook-mermaid
        uses: taiki-e/cache-cargo-install-action@v1.2.1
        with:
          tool: mdbook-mermaid@${MDBOOK_MERMAID_VERSION}
      - name: Install mdbook-template
        uses: taiki-e/cache-cargo-install-action@v1.2.1
        with:
          tool: mdbook-template@${MDBOOK_TEMPLATE_VERSION}
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Build with mdBook
        run: mdbook build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./book

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/master'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2