docs: record the pull request commit instead of the merge commit [ENG-934]

[agoldis]

Documents that the reporters record the last commit of the pull request when CI checks out a merge commit, and removes the ref: ${{ github.event.pull_request.head.sha }} checkout that we recommended to get the right commit message.

• Commit data for GitHub Actions: replaces "Temporary commit in GitHub Pull Requests" with how the reporter finds and fetches the pull request commit, the 3 second timeout, the persist-credentials: false failure case, and CURRENTS_DISABLE_HEAD_COMMIT_FETCH. The ref checkout stays for cypress-cloud and earlier reporter versions.
• Commit Information: new "Merge Commits in Pull Request Runs" section with the variable each CI provider uses for the pull request commit.
• Playwright GitHub Actions quick start: drops ref: head.sha from the example workflow.

Merge after @currents/playwright 2.5.1 and @currents/cmd 1.11.0 are on npm latest. Both versions are what release-it will pick for the pending fix: changes (currents-dev/currents-playwright#971, currents-dev/currents-reporter#421). Check them at release.

Code: currents-dev/commit-info#9. Linear: ENG-934.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LdJrRhBLEH9Uwt97JMGVTR

Summary by CodeRabbit

• New Features
  • In @currents/playwright 2.5.1 and @currents/cmd 1.11.0, pull request runs can record the source commit instead of the CI-created merge commit when its SHA is available. If needed, the reporter attempts to fetch the source commit; if fetching fails, it records the merge commit. You can disable fetching with CURRENTS_DISABLE_HEAD_COMMIT_FETCH=true.
• Documentation
  • Updated commit information and GitHub Actions guidance to explain commit selection, fetch behavior, and checkout options.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

• Run on-demand review

_{This review includes 2 billable files and costs up to $0.50.}

• Ask an admin to make reviews automatic

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Or wait 41 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available. Your 62 included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 2757a9f2-636d-445f-86c5-39b3477b4449

📥 Commits

Reviewing files that changed from the base of the PR and between 1ba4ba2 and 597119c.

📒 Files selected for processing (2)

• dashboard/runs/commit-information.md
• getting-started/ci-setup/github-actions/commit-data-for-github-actions.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 8acd830c-596c-402b-be76-0148c403fabc

📥 Commits

Reviewing files that changed from the base of the PR and between 7311ea2 and 1ba4ba2.

📒 Files selected for processing (3)

• dashboard/runs/commit-information.md
• getting-started/ci-setup/github-actions/commit-data-for-github-actions.md
• getting-started/ci-setup/github-actions/playwright-github-actions.md

💤 Files with no reviewable changes (1)

• getting-started/ci-setup/github-actions/playwright-github-actions.md

Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

---

📝 Walkthrough

Walkthrough

The documentation now describes how supported reporter versions handle pull-request merge commits, when they fetch the pull-request commit, and how GitHub Actions checkout settings affect the recorded commit.

Changes

Pull-request commit documentation

Layer / File(s)	Summary
Commit selection and checkout guidance dashboard/runs/commit-information.md, getting-started/ci-setup/github-actions/commit-data-for-github-actions.md, getting-started/ci-setup/github-actions/playwright-github-actions.md	Documents commit selection, fetch and fallback behavior, version differences, and GitHub Actions checkout options. The Quick Start workflow no longer sets an explicit pull-request head ref.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1ba4b

The documentation can be published without waiting for additional package releases.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main documentation change: recording the pull request commit instead of the CI-created merge commit. It is concise and includes the relevant issue reference.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

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

[baz-reviewer]

Baz Summary

Document how @currents/playwright and @currents/cmd detect and record pull request commits instead of CI-generated merge commits, including fetch fallback and override behavior. Update GitHub Actions guidance to remove the custom head-commit checkout for current reporters while preserving it for older versions and cypress-cloud.

Topics

Topic	Details
PR commit capture	Explain how reporters select the pull request commit across CI providers, validate it as a merge parent, fetch it when missing, and fall back safely when fetching is disabled or fails. Modified files (2) dashboard/runs/commit-information.md getting-started/ci-setup/github-actions/commit-data-for-github-actions.md Latest Contributors(2) User Commit Date agoldis@gmail.com docs: name the fields ... September 24, 2026 walter@currents.dev Streamline Get Started December 18, 2025
Workflow guidance	Update GitHub Actions examples to rely on current reporter behavior while documenting the legacy checkout required by older reporters and cypress-cloud. Modified files (2) getting-started/ci-setup/github-actions/commit-data-for-github-actions.md getting-started/ci-setup/github-actions/playwright-github-actions.md Latest Contributors(2) User Commit Date agoldis@gmail.com docs: name the fields ... September 24, 2026 miguelangaranocurrents [] feat: orchestration... May 19, 2026

  _{Activate to get a short verdict whether this PR is good to go or not}

  _{Activate Skill Maintainer to keep your skills up to date}

  _{This PR would have been improved with Baz Planner - Try it now}