From 8112b95ebeecb3d00dee7716b615e32be5e0e8eb Mon Sep 17 00:00:00 2001 From: Jonathan Pallant Date: Tue, 18 Jun 2024 12:24:42 +0100 Subject: [PATCH] Add cloudflare build script. Builds current plus older versions, like with the training. Note that backup files are mandatory if you want sed to work the same on both macOS and Linux. --- .gitignore | 5 +++- _redirects | 2 ++ cloudflare.sh | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 _redirects create mode 100755 cloudflare.sh diff --git a/.gitignore b/.gitignore index 7d75d08..e2b051c 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,7 @@ exercise-templates/Cargo.lock exercise-solutions/target exercise-solutions/Cargo.lock tools/*/target - +html/ +mdbook +mdbook-mermaid +*.backup diff --git a/_redirects b/_redirects new file mode 100644 index 0000000..4c45cfa --- /dev/null +++ b/_redirects @@ -0,0 +1,2 @@ +/ /latest/book +/:version /:version/book diff --git a/cloudflare.sh b/cloudflare.sh new file mode 100755 index 0000000..f613352 --- /dev/null +++ b/cloudflare.sh @@ -0,0 +1,65 @@ +#!/bin/bash + +# +# Ferrous Systems Cloudflare Deployment Script +# +# Copyright (c) Ferrous Systems, 2024 +# +# This script will find every tag in this repo and build the material. + +set -euo pipefail + +# We only support macOS (the x86 binaries work OK on Apple Silicon), or x86-64 Linux +if [ $(uname) == "Darwin" ]; then + ./mdbook --version || curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-apple-darwin.tar.gz | tar -xvzf - + ./mdbook-mermaid --version || curl -sSL https://github.com/badboy/mdbook-mermaid/releases/download/v0.13.0/mdbook-mermaid-v0.13.0-x86_64-apple-darwin.tar.gz | tar -xvzf - +else + ./mdbook --version || curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xvzf - + ./mdbook-mermaid --version || curl -sSL https://github.com/badboy/mdbook-mermaid/releases/download/v0.13.0/mdbook-mermaid-v0.13.0-x86_64-unknown-linux-gnu.tar.gz | tar -xvzf - +fi + +# Must be an absolute path, otherwise mdbook puts the output in the wrong place +OUTPUT_DIR=$(pwd)/html +CODE_FOLDER_LIST="exercise-solutions exercise-templates nrf52-code qemu-code" + +# Clean out whatever exists, and make the index (before we do any git checkouts +# and lose the files from this checkout) +rm -rf "${OUTPUT_DIR}" +mkdir -p "${OUTPUT_DIR}" +cp ./_redirects "${OUTPUT_DIR}/_redirects" + +# Build the book and slides +function build_and_store { + if [ "$1" == "latest" ]; then + tag="main" + else + tag="$1" + fi + mkdir -p "${OUTPUT_DIR}/$1" + # Munge all the relative source code links to point at Github + for folder in ${CODE_FOLDER_LIST}; do + echo "Processing ${folder}" + # This finds a Markdown links with relative URLs + find ./exercise-book -type f -name "*.md" -exec sed -e "s~(../../${folder}/~(https://github.com/ferrous-systems/rust-exercises/tree/${tag}/${folder}/~g" -i.backup {} \; + # This finds a Markdown references with relative URLs + find ./exercise-book -type f -name "*.md" -exec sed -e "s~]: ../../${folder}/~]: https://github.com/ferrous-systems/rust-exercises/tree/${tag}/${folder}/~g" -i.backup {} \; + done + # Build the book first, because mdbook will create any empty sections + # The PATH override lets it find our local copy of mdbook-mermaid + PATH=$PATH:. ./mdbook build -d "${OUTPUT_DIR}/$1/book" ./exercise-book +} + +# Build what we currently have checked out +build_and_store latest + +# Fetch all the git tags (in case this is some kind of shallow clone) +git fetch --tags + +for tag in $(git tag); do + echo "Building ${tag}..." + # Make a place to put the rendered output + mkdir -p "${OUTPUT_DIR}/${tag}" + # Fetch a clean copy of the source material for this tag + git checkout -f "${tag}" + build_and_store "${tag}" +done