Repository navigation
docs: name devbranch in deploydocs - #35
Conversation
Documenter otherwise reads the default branch with git remote show origin, which fails without the checkout's token on a private repository and falls back to master. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. Walkthrough
Merge Risk:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #35 +/- ##
=======================================
Coverage 67.88% 67.88%
=======================================
Files 21 21
Lines 878 878
=======================================
Hits 596 596
Misses 282 282 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
deploydocsnamesdevbranch = "main".Without it, Documenter finds the default branch with
git remote show originand falls back tomasterwhen that call fails. The call fails in a private repository whose checkout keeps no token, and the harness Documentation workflow template now checks out withpersist-credentials: false. A push tomainwould then deploy no development docs, with the job green. The repository is public today, so nothing is broken now; the explicit branch keeps the deploy independent of the visibility and of the checkout.Pre-PR verification
.github/workflows/Documenter.ymlstill uses the defaultpersist-credentials: true(the template change has not reached it), so the entry now states the condition without describing the checkout.mainis the default branch. Documenter'sgit_remote_head_branchusesgit remote show originand falls back tomaster, and that fallback skips the dev deploy onmainwith a green job.docs/make.jlpasses JuliaFormatter (sciml). The dispatch delta against the base: 0 FAIL, 0 UNKNOWN.deploydocsdoes not run outside CI, and no doctest changes).🤖 Generated with Claude Code
Summary by CodeRabbit
mainbranch. The changelog also notes the failure and fallback observed when this setting is omitted.