ci(docs): restore Documentation workflow (CPU runner) to fix stable docs#142
Open
ChrisRackauckas wants to merge 1 commit into
Open
ci(docs): restore Documentation workflow (CPU runner) to fix stable docs#142ChrisRackauckas wants to merge 1 commit into
ChrisRackauckas wants to merge 1 commit 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>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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