fix: error with embedify, add caching

Author: jeffabailey

.github/workflows/mdbook-pr-preview.yml

@@ -25,11 +25,45 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Cache Cargo registry and git index
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.CARGO_HOME }}/registry
+            ${{ env.CARGO_HOME }}/git
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Rust toolchains
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.RUSTUP_HOME }}/toolchains
+            ${{ env.RUSTUP_HOME }}/update-hashes
+          key: ${{ runner.os }}-rust-toolchain-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-rust-toolchain-
+
+      - name: Cache installed mdBook binaries
+        id: mdbook-cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.CARGO_HOME }}/bin
+          key: ${{ runner.os }}-mdbook-bin-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-mdbook-bin-
+
       - name: Install mdBook
+        if: steps.mdbook-cache.outputs.cache-hit != 'true'
         run: bash scripts/install-mdbook.sh
         env:
           REPO_ROOT: ${{ github.workspace }}
 
+      - name: Add Cargo bin to PATH
+        run: echo "${CARGO_HOME}/bin" >> "$GITHUB_PATH"
+
       - name: Build with mdBook
         run: ${{ env.CARGO_HOME }}/bin/mdbook build
 

.github/workflows/mdbook.yml

@@ -33,10 +33,42 @@ jobs:
       RUSTUP_HOME: ${{ github.workspace }}/.rustup
     steps:
       - uses: actions/checkout@v4
+      - name: Cache Cargo registry and git index
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.CARGO_HOME }}/registry
+            ${{ env.CARGO_HOME }}/git
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Rust toolchains
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.RUSTUP_HOME }}/toolchains
+            ${{ env.RUSTUP_HOME }}/update-hashes
+          key: ${{ runner.os }}-rust-toolchain-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-rust-toolchain-
+
+      - name: Cache installed mdBook binaries
+        id: mdbook-cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.CARGO_HOME }}/bin
+          key: ${{ runner.os }}-mdbook-bin-${{ hashFiles('scripts/install-mdbook.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-mdbook-bin-
       - name: Install mdBook
+        if: steps.mdbook-cache.outputs.cache-hit != 'true'
         run: bash scripts/install-mdbook.sh
         env:
           REPO_ROOT: ${{ github.workspace }}
+      - name: Add Cargo bin to PATH
+        run: echo "${CARGO_HOME}/bin" >> "$GITHUB_PATH"
       - name: Setup Pages
         if: ${{ !env.ACT }}
         id: pages

scripts/install-mdbook.sh

@@ -1,11 +1,12 @@
 #!/usr/bin/env bash
 # Install mdBook and plugins (same versions as CI). Safe to run locally.
 # Usage: ./scripts/install-mdbook.sh   (from repo root)
-set -e
+set -euo pipefail
 
 MDBOOK_VERSION="${MDBOOK_VERSION:-0.5.2}"
 MDBOOK_MERMAID_VERSION="${MDBOOK_MERMAID_VERSION:-0.17.0}"
 MDBOOK_EMBEDIFY_VERSION="${MDBOOK_EMBEDIFY_VERSION:-0.3.2}"
+RUST_TOOLCHAIN_VERSION="${RUST_TOOLCHAIN_VERSION:-1.91.1}"
 
 # Install into repo so CI and local use the same layout (avoids cross-device issues in act)
 REPO_ROOT="${REPO_ROOT:-$(git rev-parse --show-toplevel 2>/dev/null || echo "$PWD")}"
@@ -14,14 +15,18 @@ export CARGO_HOME="${REPO_ROOT}/.cargo"
 
 echo "Installing Rust and mdBook into ${REPO_ROOT} (RUSTUP_HOME=$RUSTUP_HOME, CARGO_HOME=$CARGO_HOME)"
 
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-modify-path
-source "${CARGO_HOME}/env"
-rustup update
+if ! command -v rustup >/dev/null 2>&1; then
+	curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-modify-path
+	source "${CARGO_HOME}/env"
+fi
+
+rustup toolchain install "${RUST_TOOLCHAIN_VERSION}" --profile minimal
+rustup default "${RUST_TOOLCHAIN_VERSION}"
 
 cargo install --version "${MDBOOK_VERSION}" mdbook
 cargo install --version "${MDBOOK_MERMAID_VERSION}" mdbook-mermaid
 cargo install --version "${MDBOOK_EMBEDIFY_VERSION}" mdbook-embedify
 
 echo "Done. To build the book, use the project mdbook (do not use your global 'mdbook'):"
-echo "  ./mdbook build"
+echo "  ${CARGO_HOME}/bin/mdbook build"
 echo "Or: source \"${CARGO_HOME}/env\" && mdbook build"