Files
matrix-authentication-service/misc/build-docs.sh
T
Quentin Gliech dbbb93915e Declare the Node.js version in devEngines.runtime
`pnpm/setup` reads the runtime version from `package.json` and ignores `.node-version`. With `onFail: download`, pnpm records Node 24.15.0 in the lockfile and downloads it on every install unless `--no-runtime` is passed. The Dockerfile and the docs build pass it, since they already run a pinned Node. `.node-version` stays for the Cloudflare Pages build, which reads it to pick the Node that bootstraps corepack.
2026-09-07 16:04:48 +02:00

64 lines
2.1 KiB
Bash

#!/bin/sh
# Copyright 2025, 2026 Element Creations Ltd.
# Copyright 2025 New Vector Ltd.
#
# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
# Please see LICENSE files in the repository root for full details.
#
# This script is used by the Cloudflare Pages to build the documentation.
# It detects if it's running in the Cloudflare Pages build environment and will install the required dependencies.
# It can also be used locally to build the documentation, given that the required dependencies are installed.
set -eux
# Install the dependencies if we're in the Cloudflare Pages build environment
# In this environment, the CF_PAGES environment variable is set to 1
if [ "${CF_PAGES:-""}" = "1" ]; then
MDBOOK_VERSION=0.5.0
# Install rustup
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
# Source the environment variables to add cargo to the path
. "$HOME/.cargo/env"
# Install the toolchain pinned in rust-toolchain.toml
rustup toolchain install
# Install mdbook
MDBOOK_URL="https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-$(uname -m)-unknown-linux-gnu.tar.gz"
curl --proto '=https' --tlsv1.2 -sSfL "${MDBOOK_URL}" | tar -C "$HOME/.cargo/bin" -xzv
# Enable pnpm via corepack (Node and corepack are pre-installed on Cloudflare
# Pages, which picks the Node version from .node-version)
corepack enable
fi
# Sanity check
rustdoc --version
rustc --version
cargo --version
mdbook --version
pnpm --version
# Build the docs
mdbook build
# Build the rustdoc
# This is required to be able to use the unstable `-Zrustdoc-map` flag
env RUSTC_BOOTSTRAP=1 \
cargo doc -Zrustdoc-map --workspace --lib --no-deps
# Delete the rustdoc lockfile
rm target/doc/.lock
# Move the Rust documentation within the mdBook
rm -rf target/book/rustdoc
mv target/doc target/book/rustdoc
# Build the frontend storybook
# Node is already provided by Cloudflare Pages / the CI runner, so skip pnpm's
# own runtime download.
pnpm install --frozen-lockfile --no-runtime
pnpm --filter mas-frontend exec storybook build -o ../target/book/storybook