Skip to content

fix: remove explicit ref from docs job checkout to support fork PRs - #1126

Merged
nh13 merged 1 commit into
mainfrom
fix-fork-pr-docs-checkout
Jul 22, 2026
Merged

fix: remove explicit ref from docs job checkout to support fork PRs#1126
nh13 merged 1 commit into
mainfrom
fix-fork-pr-docs-checkout

Conversation

@nh13

@nh13 nh13 commented Dec 17, 2025

Copy link
Copy Markdown
Member

Fixes the issue in #1125 where the markdown doc generation failed: https://github.com/fulcrumgenomics/fgbio/actions/runs/20318274458/job/58367927183?pr=1125

This was due to github.head_ref checkout out the right branch name but the wrong repo (not the fork).

@nh13
nh13 requested review from clintval and tfenne as code owners December 17, 2025 22:00
@coderabbitai

coderabbitai Bot commented Dec 17, 2025

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 31 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 94c9e01a-77fe-4516-9a46-57eb6376576a

📥 Commits

Reviewing files that changed from the base of the PR and between c728525 and ce2c5a1.

📒 Files selected for processing (1)
  • .github/workflows/unittests.yaml
📝 Walkthrough

Walkthrough

The workflow removes explicit ref assignments from two Checkout steps in the unittests workflow. The test job and docs generation step now rely on default Checkout behavior instead of forcing github.head_ref. Both steps maintain fetch-depth: 0, with the test job also keeping lfs: true. No logic changes, error handling modifications, or public entity alterations are included.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed Title accurately describes the main change: removing explicit ref from docs job checkout to fix fork PR support.
Description check ✅ Passed Description directly relates to the changeset, referencing issue #1125 and explaining the root cause of the checkout failure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-fork-pr-docs-checkout

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Dec 17, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.95%. Comparing base (a2b31ad) to head (ce2c5a1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1126   +/-   ##
=======================================
  Coverage   95.95%   95.95%           
=======================================
  Files         132      132           
  Lines        8347     8347           
  Branches      984      984           
=======================================
  Hits         8009     8009           
  Misses        338      338           
Flag Coverage Δ
unittests 95.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@github-actions

github-actions Bot commented Dec 17, 2025

Copy link
Copy Markdown
PR Preview Action v1.6.1

🚀 View preview at
https://fulcrumgenomics.github.io/fgbio/pr-preview/pr-1126/

Built to branch gh-pages at 2026-07-22 22:39 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@nh13
nh13 force-pushed the fix-fork-pr-docs-checkout branch from c728525 to ce2c5a1 Compare July 22, 2026 22:33
@nh13
nh13 merged commit 798aca4 into main Jul 22, 2026
13 checks passed
@nh13
nh13 deleted the fix-fork-pr-docs-checkout branch July 22, 2026 23:15
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.

2 participants