Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/workflows/book-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Documentation and mdbook related jobs.
# Heavily inspired by Reth https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml

name: book-tests

on:
pull_request:
branches: [main]
paths:
- 'book/**'

jobs:
test:
runs-on: ubuntu-latest
name: test
timeout-minutes: 60

steps:
- uses: actions/checkout@v4

- name: Install mdbook
run: |
mkdir mdbook
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo $(pwd)/mdbook >> $GITHUB_PATH
- name: Install mdbook-template
run: |
mkdir mdbook-template
curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-template
echo $(pwd)/mdbook-template >> $GITHUB_PATH
- name: Run tests
working-directory: ./book
run: mdbook test

lint:
runs-on: ubuntu-latest
name: lint
timeout-minutes: 60

steps:
- uses: actions/checkout@v4

- name: Install mdbook-linkcheck
run: |
mkdir mdbook-linkcheck
curl -sSL -o mdbook-linkcheck.zip https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip
unzip mdbook-linkcheck.zip -d ./mdbook-linkcheck
chmod +x $(pwd)/mdbook-linkcheck/mdbook-linkcheck
echo $(pwd)/mdbook-linkcheck >> $GITHUB_PATH
- name: Run linkcheck
working-directory: ./book
run: mdbook-linkcheck --standalone
133 changes: 0 additions & 133 deletions .github/workflows/book.yml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was this meant to be deleted?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, renamed to book-tests because it's just tests now. No strong feelings about file name.

This file was deleted.

56 changes: 56 additions & 0 deletions .vercel/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#!/bin/bash
set -e

mkdir -p $HOME/bin
export PATH=$HOME/bin:$PATH
REPO_ROOT=$(pwd)

echo "Installing mdbook..."
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz
chmod +x ./mdbook
cp ./mdbook $HOME/bin/

echo "Installing mdbook-template..."
curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz
chmod +x ./mdbook-template
cp ./mdbook-template $HOME/bin/

echo "Installing Rust..."
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | RUSTUP_HOME=/tmp/rustup HOME=/tmp sh -s -- -y
export PATH="/tmp/.cargo/bin:$PATH"
export RUSTUP_HOME=/tmp/rustup
export CARGO_HOME=/tmp/.cargo

rustup toolchain install nightly
rustup default nightly

echo "Verifying installations..."
which mdbook
which mdbook-template
rustc --version

echo "Building the book..."
cd "${REPO_ROOT}/book"
mdbook build

echo "Building Rust documentation..."
cd "${REPO_ROOT}"
export RUSTDOCFLAGS="--cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page -Zunstable-options"
cargo doc --all-features --no-deps || {
echo "Cargo doc failed, but continuing with mdbook only"
}

# Try to copy the API docs if they were generated
if [ -d "${REPO_ROOT}/target/doc" ]; then
echo "Copying API documentation..."
mkdir -p "${REPO_ROOT}/book/book/api"
cp -r "${REPO_ROOT}/target/doc"/* "${REPO_ROOT}/book/book/api/"
else
echo "API documentation not generated, continuing with mdbook only"
fi

# Create a final output directory for Vercel
mkdir -p "${REPO_ROOT}/vercel-output"
cp -r "${REPO_ROOT}/book/book"/* "${REPO_ROOT}/vercel-output/"

echo "Build completed successfully!"
6 changes: 3 additions & 3 deletions book.toml → book/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
authors = ["Rollup Boost Core Contributors"]
language = "en"
multilingual = false
src = "book"
src = "src"
title = "Rollup Boost"
description = "The Rollup Boost is a sidecar to enable rollup extensions"

[output.html]
theme = "book/theme"
theme = "theme"
git-repository-url = "https://github.com/flashbots/rollup-boost"
default-theme = "ayu"
no-section-label = true
Expand All @@ -17,4 +17,4 @@ enable = true
level = 1

[build]
build-dir = "target/book"
build-dir = "book"
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions vercel.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"version": 2,
"buildCommand": "chmod +x ./.vercel/build.sh && ./.vercel/build.sh",
"outputDirectory": "vercel-output",
"ignoreCommand": "git diff --quiet HEAD^ HEAD ./book/",
"github": {
"silent": false,
"autoJobCancelation": true
}
}
Loading