Prefer GITHUB_TOKEN for documentation deploy - #138
Merged
ChrisRackauckas merged 1 commit intoSep 9, 2026
Merged
ChrisRackauckas merged 1 commit into
ChrisRackauckas merged 1 commit into
Conversation
Passing a stale org-level DOCUMENTER_KEY makes Documenter fetch git@github.com over SSH and fail with "Could not read from remote repository", even when GITHUB_TOKEN has contents:write. That is why docs jobs that use the reusable workflow fail on deploy after the build itself succeeds (SciMLWorkshop, MethodOfLines, MathML, …). SSH deploy is now opt-in via use-documenter-key. Checkout no longer persists credentials, and the job requests contents:write. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Grok <noreply@x.ai> Agent-Harness: Grok Build 1.0.24 Agent-Model: grok-4.6 Agent-Session: 01a08654-45f1-7a53-849c-56a7f1531d56 (local Grok Build session; no public conversation URL)
ChrisRackauckas
marked this pull request as ready for review
September 9, 2026 19:32
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
2 participants
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.
Stop passing a stale
DOCUMENTER_KEYinto the reusable documentation workflow.Documenter deploys over SSH whenever
DOCUMENTER_KEYis non-empty. The org-level secret is present but cannotgit fetch git@github.com:SciML/<pkg>.git, so jobs that already havecontents: writeonGITHUB_TOKENstill fail at deploy with:This is the common failure on SciMLWorkshop.jl, MethodOfLines.jl, MathML.jl, FiniteVolumeMethod.jl, DiffEqParamEstim.jl, NBodySimulator.jl, and several others. DiffEqDocs.jl, which only passes
GITHUB_TOKEN, deploys successfully.SSH deploy is now opt-in via
use-documenter-key(defaultfalse). Checkout usespersist-credentials: false. The job requestscontents: write.Verification
v1.xtag;@v1consumers pick this up when the movingv1tag is updated after merge.Links
🤖 Generated with Grok Build 1.0.24 (model: grok-4.6)
Session:
01a08654-45f1-7a53-849c-56a7f1531d56(local Grok Build session; no public conversation URL)