Skip to content

ci: write the job summary from one matrix leg, not three - #255

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/refresh-sample-output-602anc
Aug 6, 2026
Merged

ci: write the job summary from one matrix leg, not three#255
shenxianpeng merged 1 commit into
mainfrom
claude/refresh-sample-output-602anc

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 6, 2026

Copy link
Copy Markdown
Member

The run page currently shows three summaries:

commit-check (ubuntu-latest) summary
commit-check (macos-latest) summary
commit-check (windows-latest) summary

All three are byte-identical. Every leg checks the same commits against the
same rules, so the report cannot differ between them — the matrix is here to
prove the action runs on each OS, not to say the same thing three times.

pr-comments was already guarded exactly this way two lines below, to stop
the same duplication on the comment surface. This applies the same guard to
the surface that was still missing it:

job-summary: ${{ matrix.os == 'ubuntu-latest' }}

The other two legs still run every check and still fail the job on a
violation — they just stop writing a duplicate report.

Why not rename it to plain commit-check summary

That heading text is generated by GitHub from the job name, and a matrix
job's name is <job-id> (<matrix values>). Getting the suffix off it means
splitting this into a reporting job plus a separate cross-platform job, which
changes the check names and would need any required-status-check settings on
main updated to match. Not worth it for the suffix; out of scope here.


Generated by Claude Code

Summary by CodeRabbit

  • Chores
    • Updated workflow reporting so job summaries are generated only for the Ubuntu matrix job.
    • Preserved pull-request comment reporting for Ubuntu jobs.

Every leg checks the same commits against the same rules, so all three
produce a byte-identical report and the run page carries three copies of
it. The matrix is here to prove the action runs on ubuntu, macos and
windows — not to say the same thing three times.

pr-comments was already guarded this way two lines below; this is the
same guard on the surface that was still missing it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn
@shenxianpeng
shenxianpeng requested a review from a team as a code owner August 6, 2026 08:25
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8e9d1b4c-bcfd-4fc6-991b-e78e8886b31d

📥 Commits

Reviewing files that changed from the base of the PR and between fa56a91 and 23720b9.

📒 Files selected for processing (1)
  • .github/workflows/commit-check.yml

📝 Walkthrough

Walkthrough

The commit-check workflow now enables job-summary only for the ubuntu-latest matrix job. Comments explain the single-report behavior across the operating system matrix. Pull-request comment behavior remains restricted to Ubuntu jobs.

Changes

CI job summary

Layer / File(s) Summary
Restrict job-summary output
.github/workflows/commit-check.yml
The workflow enables job-summary only when matrix.os is ubuntu-latest. Comments document the single-report behavior. The existing Ubuntu pull-request comment condition remains unchanged.

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

🚥 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 describes the main CI change: one matrix leg writes the job summary instead of all three.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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)
  • Create PR with unit tests
  • Commit unit tests in branch claude/refresh-sample-output-602anc

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

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

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Commit Check

All 5 checks passed

Show all 5 checks
Commit message
  ✔ PR title (ci: write the job summary from one matrix leg, not three)
  ✔ Commit 1/1 (ci: write the job summary from one matrix leg, not three)
Branch
  ✔ Branch (claude/refresh-sample-output-602anc)
Author
  ✔ Author name (Xianpeng Shen)
  ✔ Author email (xianpeng.shen@gmail.com)

commit-check 2.13.1 · Rules reference

@shenxianpeng
shenxianpeng merged commit b78ea95 into main Aug 6, 2026
13 checks passed
@shenxianpeng
shenxianpeng deleted the claude/refresh-sample-output-602anc branch August 6, 2026 08:29
@shenxianpeng shenxianpeng added the chore Choses update label Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Choses update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant