Merge pull request #893 from Kobzol/blacksmith-cache

Make blacksmith optional

Author: Kobzol

.github/workflows/deploy.yml

@@ -10,6 +10,7 @@ jobs:
   build:
     env:
       MDBOOK_VERSION: 0.4.51
+      RUN_BLACKSMITH: 1
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/test.yml

@@ -8,6 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       MDBOOK_VERSION: 0.4.51
+      RUN_BLACKSMITH: 1
     steps:
       - uses: actions/checkout@v4
       - name: Install mdbook

README.md

@@ -30,6 +30,14 @@ On CI, we automatically check if all intra-doc links in the Forge Markdown files
 perform this check locally, install `mdbook-linkcheck` using `cargo install [email protected] --locked` and then
 simply run `mdbook build` or `mdbook serve`.
 
+## Blacksmith
+
+Blacksmith is a tool that can run before the Forge is built. It downloads information about Rust releases, which is used
+to render a page with historical Rust releases.
+
+Since it takes a while to compile and run, it is disabled by default. To enable it, run `mdbook serve` or `mdbook build`
+with the environment variable `RUN_BLACKSMITH=1`.
+
 ## JavaScript
 
 Forge uses JavaScript to display dates for releases and "no tools breakage

build.bash

@@ -4,4 +4,9 @@ set -euo pipefail
 CARGO_TARGET_DIR=${CARGO_TARGET_DIR:-"$PWD"/target}
 export CARGO_TARGET_DIR
 
-cargo run --locked --manifest-path=blacksmith/Cargo.toml -- "$@"
+if [ "${RUN_BLACKSMITH:-0}" = "1" ]; then
+  cargo run --locked --manifest-path=blacksmith/Cargo.toml -- "$@"
+else
+  # This actually tells mdbook that we don't support the given renderer
+  exit 1
+fi