Skip to content

docs: name devbranch in deploydocs - #35

Merged
michakraus merged 2 commits into
mainfrom
docs/devbranch
Nov 14, 2026
Merged

michakraus merged 2 commits into
mainfrom
docs/devbranch

Conversation

@michakraus

@michakraus michakraus commented Nov 14, 2026 •

Copy link
Copy Markdown
Member

deploydocs names devbranch = "main".

Without it, Documenter finds the default branch with git remote show origin and falls back to master when that call fails. The call fails in a private repository whose checkout keeps no token, and the harness Documentation workflow template now checks out with persist-credentials: false. A push to main would 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

  • Fixed: the CHANGELOG entry first said that this repository's Documentation workflow checks out without keeping the token. Its .github/workflows/Documenter.yml still uses the default persist-credentials: true (the template change has not reached it), so the entry now states the condition without describing the checkout.
  • Unresolved: none.
  • Pre-existing: none.
  • Checked and clean: main is the default branch. Documenter's git_remote_head_branch uses git remote show origin and falls back to master, and that fallback skips the dev deploy on main with a green job. docs/make.jl passes JuliaFormatter (sciml). The dispatch delta against the base: 0 FAIL, 0 UNKNOWN.
  • Not checked: type stability and allocations (no executable change); the docs build and doctests (deploydocs does not run outside CI, and no doctest changes).
  • Release: no bump needed.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the changelog to record higher minimum compatibility requirements for several dependencies, including a test-only dependency, and checks related to resolving downgrades on Julia 1.12.
    • Updated documentation deployment settings to use the main branch. The changelog also notes the failure and fallback observed when this setting is omitted.

michakraus and others added 2 commits November 14, 2026 12:40
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>
@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

deploydocs now specifies main as the development branch. The Unreleased changelog records this setting and describes the documented branch-detection failure and fallback.

Changes: Documentation deployment branch

Layer / File(s) Summary
Set documentation development branch
docs/make.jl, CHANGELOG.md
deploydocs specifies main as the development branch. The changelog records this setting and describes the documented fallback behavior.

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

Change: Other

Merge Risk: Minimal · up to 62e07

This sets the documentation deployment branch explicitly to main, so dev docs keep deploying on pushes to main regardless of repository visibility or checkout credentials. No merge-blocking risk was found.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs: name devbranch in deploydocs" matches the main change. The PR adds devbranch = "main" to the deploydocs call in docs/make.jl, and the CHANGELOG entry supports that change. The title i…
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.
Full details: Title check

Explanation

The title "docs: name devbranch in deploydocs" matches the main change. The PR adds devbranch = "main" to the deploydocs call in docs/make.jl, and the CHANGELOG entry supports that change. The title is short, specific, and uses a conventional prefix. It does not mention the CHANGELOG compat floor increases, but the title does not need to cover every detail.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9f698388-0dd2-46e4-b114-0697755d9452
Commits

Reviewing files that changed from the base of the PR and between 93a104b and 62e0795.

Files selected for processing: 2

  • CHANGELOG.md
  • docs/make.jl

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@codecov

codecov Bot commented Nov 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.88%. Comparing base (93a104b) to head (62e0795).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@michakraus
michakraus merged commit ada634c into main Nov 14, 2026
14 checks passed
@michakraus
michakraus deleted the docs/devbranch branch November 14, 2026 12:22
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