Repository navigation
ci(docs): restore Documentation workflow (CPU runner) to fix stable docs - #142
ChrisRackauckas wants to merge 3 commits into
Conversation
Docs CI was removed from GHA in #99 (2024-07) and #130 to restore it was closed unmerged, so `main` has had no documentation workflow. As a result `stable` is frozen at v1.2.1 (2022): no v2.x release ever deployed docs. The v2.x tag builds that did run used a self-hosted GPU runner and segfaulted (exit 139) during `docs/make.jl` ExpandTemplates, crashing before `deploydocs`. Every executed `@example` block uses `use_cuda = false` (the `use_cuda = true` snippets are static, non-executed fences), so the build needs no GPU. Running on `ubuntu-latest` avoids the segfault and deploys correctly. DOCUMENTER_KEY + deploy key are already configured on the repo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Independent review (devin / fusion-gpt-6-1-sol-high-sidekick-swe-2-medium), reviewer session unknown, reviewed head f92fdfe
This is a blind code-only review by a session other than the PR author's, copied below from the reviewer's report with only the grading metadata removed. The posting agent did not re-run the reviewer's commands. A MERGE verdict is advice; merging is left to the maintainers. Risklow (L3: repository-local documentation CI; no package code, dependencies, numerical assertions or public APIs change) Blocking findings
Non-blocking findings
What I ran
What I did not verify
🤖 Posted by an AI agent — harness: Claude Code 2.1.322 · model: claude-sonnet-5-5 |
Documentation.yml is the single documentation build and deploy workflow; GPU.yml keeps only the GPU test job. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Muse <noreply@meta.com> Agent-Harness: Muse CLI Code Agent-Model: muse-wonder-full-1.0 Agent-Session: local fixer job SciML__HighDimPDE.jl__142 (no session URL)
Problem
https://docs.sciml.ai/HighDimPDE/stable/is frozen at v1.2.1 (June 2022). The deepbsde tutorial (and all current content) shows up under/dev/but never reaches/stable/, even though it's present in the v2.3.0 source.Root cause
main. Docs CI was deliberately removed from GitHub Actions in ci(docs): remove documentation workflow from GHA #99 (merged 2024-07-17), and Add Documentation CI workflow #130 ("Add Documentation CI workflow") was closed unmerged. So nothing has deployed docs frommain.documentation.ymlthat survived on the release tags ran on a self-hosted GPU runner and segfaulted (exit 139) duringdocs/make.jlExpandTemplates, crashing beforedeploydocs. So no v2.x version (v2.0.0–v2.3.0) was ever published togh-pages—versions.jsstill hasDOCUMENTER_NEWEST = "v1.2.1", andstable → v1.2.1.Net:
devis a stale leftover from an old successful deploy;stablecannot advance until a tagged release completes a clean docs build.Fix
Restore
.github/workflows/Documentation.yml, but run onubuntu-latest(CPU) instead of the self-hosted GPU box:@exampleblock usesuse_cuda = false. Theuse_cuda = truesnippets are static```juliafences (not evaluated), and no executed block doesusing CUDA. So the build needs no GPU, and the CPU runner sidesteps the segfault.main(deploysdev), tag pushes (deploys the version + repointsstable), andpull_request(build-only validation). Addedworkflow_dispatchso a maintainer can manually deploy against an existing tag.DOCUMENTER_KEYsecret and matching read-write deploy key.Validation
This PR's own
pull_requestrun exercises the fulldocs/make.jlbuild onubuntu-latest(Documenter skipsdeploydocson PRs, so it's a safe build-only check). Confirm it goes green before merging.After merge — to actually repoint
stablestableonly moves on a tagged-release build. Two options:stable.workflow_dispatchagainst tagv2.3.0to deploy v2.3.0 docs and repointstablewithout waiting for a new release.🤖 Generated with Claude Code
Risk assessment
Fix by Muse CLI Code muse-wonder-full-1.0 (head 6c04bfb)
gpu-docsjob from.github/workflows/GPU.yml, which built and deployeddocs/make.jlwithDOCUMENTER_KEY.GPU.ymlnow runs only thegpu-testsjob, so.github/workflows/Documentation.ymlis the sole documentation publisher and source-changing pushes tomainno longer schedule two deployments.Documentation.ymlcomment to the present-tense CPU requirement (use_cuda = false, no GPU required); the historical GPU failure account stays in this PR description.Validation (exact commands, tail of real output):
gpu-testsremains, counts workflows runningdocs/make.jlwithDOCUMENTER_KEY) — before the fix:docs publishers (2): ['.github/workflows/Documentation.yml', '.github/workflows/GPU.yml']/FAIL: expected exactly one docs publisher(exit 1); after the fix:GPU.yml jobs: ['gpu-tests']/docs publishers (1): ['.github/workflows/Documentation.yml']/PASS: exactly one docs publisher(exit 0).python3YAML parse of all 11 workflow files: allok;git diff --check: exit 0.actionlintis unavailable in this environment.typos .github/workflows/Documentation.yml .github/workflows/GPU.yml: exit 0. No.jlfiles change, so Runic has no files to format in this diff.GROUP=QA julia --project -e 'using Pkg; Pkg.test()'(Julia 1.13.2,JULIA_NUM_THREADS=4):QA | 19 1 20— 19 passes with onePersistent taskserror from localCUDA_Runtime_jllprecompilation. The identical run on a clean checkout of the default branch gives the same19 pass / 1 errorsummary, so that error is pre-existing and unrelated to this workflow-only diff; QA passed in CI at the previous head.6c04bfb; CI started (checks pending at the single post-push look,typos-checkalready passing). CI was not waited on.Next counted review must come from a smart model in a fresh session, not this fix session (risk.md § Independent reviews).
🤖 Posted by an AI agent — harness: Muse CLI Code · model: muse-wonder-full-1.0
Conversation: local fixer job SciML__HighDimPDE.jl__142 (no session URL)