Skip to content

fix(docs): resolve doc-gen4 before docs build (lets Pages deploy)#22

Merged
Robby955 merged 1 commit into
mainfrom
formalslt/docs-ci-fix-2026-07-02
Jul 3, 2026
Merged

fix(docs): resolve doc-gen4 before docs build (lets Pages deploy)#22
Robby955 merged 1 commit into
mainfrom
formalslt/docs-ci-fix-2026-07-02

Conversation

@Robby955

@Robby955 Robby955 commented Jul 3, 2026

Copy link
Copy Markdown
Owner

First lake command runs with -Kenv=dev so doc-gen4's docs facet registers before the build. Validated on run 28635186013 — build-docs green, full mathlib doc closure built in ~57m, artifact uploaded; deploy waited on the main-only branch policy. Merging publishes.

Summary by CodeRabbit

  • Documentation
    • Improved the docs publishing workflow so documentation builds are more reliable.
    • Updated the caching and build steps used for generating and deploying the site, helping avoid missing documentation errors during the process.

The Docs workflow ran the initial `lake exe cache get` without -Kenv=dev,
which elaborated and cached a lakefile config that omits the conditional
doc-gen4 dev dependency. The later `lake -Kenv=dev build FormalSLT:docs`
reused that cached config, so doc-gen4 was never cloned and its `docs`
library facet stayed unregistered, failing with
"unknown lean_lib facet `docs`".

Run the cache-get step with -Kenv=dev so the first Lake invocation
elaborates the config with doc-gen4 active and clones it (plus its
transitive deps) alongside the Mathlib olean download. The conditional
dev-dependency design is unchanged; the normal build stays doc-gen4-free.
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 902e40c8-cd77-4862-8361-27e39522ff33

📥 Commits

Reviewing files that changed from the base of the PR and between 26be272 and 19dca78.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

📝 Walkthrough

Walkthrough

The GitHub Actions docs workflow's cache retrieval step was renamed and modified to run lake -Kenv=dev exe cache get instead of lake exe cache get, with added comments explaining that this ensures doc-gen4 dev dependency elaboration for later docs facet resolution.

Changes

Docs Workflow Cache Update

Layer / File(s) Summary
Update Lake cache step for doc-gen4 resolution
.github/workflows/docs.yml
The cache step is renamed to "Get Mathlib cache and resolve doc-gen4," its command now uses -Kenv=dev, and comments explain the dev environment requirement for facet resolution.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main fix: resolving doc-gen4 before the docs build to unblock Pages deployment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch formalslt/docs-ci-fix-2026-07-02

Comment @coderabbitai help to get the list of available commands.

@Robby955
Robby955 merged commit 5fc1219 into main Jul 3, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant