You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
make mdbook CI steps use pipefail when teeing build output
build docs/book and docs/reference once each while keeping logs visible in the job output
remove grep-based ERROR handling that could miss non-ERROR failures or mask command status
Why
The mdbook build job was piping output through tee without preserving the mdbook exit code, and the reference book was built twice. If mdbook failed without a matching ERROR line, the step could still exit successfully or make the failure harder to diagnose.
Low Risk
Only .github/workflows/ci.yml changes in the docs build job; no application or auth logic.
Overview
Updates the build-mdbook job so doc builds fail reliably and run once per book.
The old steps piped mdbook build through tee without pipefail, then treated success as “no ERROR in the log.” That could let real mdbook failures slip through when output didn’t match that pattern. The reference book was also built twice (once discarded, once captured).
Each book now has a dedicated step (docs/book with strict forc-documenter, docs/reference) using set -o pipefail and tee to /tmp/mdbook-*.log, so the step fails on mdbook’s exit code while logs stay in the job output.
Reviewed by Cursor Bugbot for commit a572e46. Bugbot is set up for automated code reviews on this repo. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
The mdbook build job was piping output through tee without preserving the mdbook exit code, and the reference book was built twice. If mdbook failed without a matching ERROR line, the step could still exit successfully or make the failure harder to diagnose.
Testing