fix: warn when a PR comment fails to post, and name the right permission

[shenxianpeng]

The 403 hint named the wrong permission

add_pr_comments caught a 403 and told the user to grant issues: write. A PR
comment is written with the pull-requests scope — issues: write does not
grant it, so following the hint does not fix the failure. The hint is the only
guidance a user gets at that point, which is what made it worth fixing.

Every other failure was silent

Posting the comment is best-effort: all three failure paths return 0 so the
step stays green. That is deliberate and unchanged. But the non-403 paths only
printed to stderr, so the outcome was a green run, no comment, and nothing on
the page saying why. They now emit ::warning:: like the 403 path already did.

main_test.py gains TestAddPrCommentsFailures covering all three. Each test
was checked against the un-fixed code first: reverting the permission name
fails the first, reverting either ::warning:: prefix fails the other two.
98 passed after the fix.

Workflow examples

• Dropped push: from the README example. pr-comments only does anything on
  pull_request, which made pr-comments: ${{ github.event_name == 'pull_request' }}
  a conditional that could only ever be true — it is now just true.
• actions/checkout v5 → v7 in the README, both docs/fork-pr-comments.md
  examples, and examples/commit-check-workflow-a.yml. The repo's own
  workflow was already on v7.0.1.

Correction to a commit already on this branch

3751d44 ("show the report inline instead of linking four missing
screenshots") is on this branch, and its commit message is wrong on the
facts. It claims commit-check/.github/screenshot/ "does not exist and never
has". It does exist and contains all four PNGs — I had been inspecting a
different repository that happens to share the name .github.

The change itself still stands, for two reasons that do hold:

• The links were /blob/ URLs, which serve text/html, so Markdown rendered
  them as broken images regardless of the files being there.
• The PNGs predate feat: render structured output for step log, job summary, and PR comments #251 and show the old output — an ASCII-art banner in a
  code block, no result table, no rule IDs. They no longer describe what this
  action prints.

Refreshing the four screenshots in commit-check/.github and restoring them
with raw.githubusercontent.com URLs remains an option; it is not in this PR.

---

Generated by Claude Code

Summary by CodeRabbit

• Bug Fixes

  • Pull-request comment failures now appear as GitHub Actions warnings without failing the workflow.
  • Permission guidance for comment-posting errors now correctly recommends pull-requests: write.
  • Improved handling of comment updates, duplicate comments, and adoption of legacy comments.

• Documentation

  • Expanded workflow documentation with success and failure examples.
  • Clarified scope-based check counts and pull-request comment behavior.
  • Updated workflow examples to use the latest checkout action and removed screenshot-based examples.

[coderabbitai]

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dded5fd7-ce64-42d3-a0b0-2d497e901a43

📥 Commits

Reviewing files that changed from the base of the PR and between b97366c and afedd6f.

📒 Files selected for processing (5)

• README.md
• docs/fork-pr-comments.md
• examples/commit-check-workflow-a.yml
• main.py
• main_test.py

📝 Walkthrough

Walkthrough

The PR updates pull-request comment failure warnings and tests. It upgrades checkout actions in workflow examples. The README now documents rendered job summaries, scope-based counts, and pull-request comment update and deduplication behavior.

Changes

Comment handling and documentation

Layer / File(s)	Summary
Pull-request comment failure handling main.py, main_test.py	PR comment failures now emit warnings and use pull-requests: write guidance. Tests cover forbidden, API, and unexpected exceptions.
Workflow and report documentation README.md, docs/fork-pr-comments.md, examples/commit-check-workflow-a.yml	Workflow examples use checkout v7. The README documents rendered reports, scope-based counts, and pull-request comment update and deduplication behavior.

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

Possibly related PRs

• commit-check/commit-check-action#182: Earlier changes to add_pr_comments() that this PR refines.
• commit-check/commit-check-action#243: Related changes to comment error handling and warning output.
• commit-check/commit-check-action#251: Related updates to add_pr_comments() and permission failure handling.

Suggested labels: bug, documentation

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main changes: warning on failed PR comment posting and correction of the required permission.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Commit Check

✅ All 7 checks passed

Show all 7 checks

Commit message
  ✔ PR title (fix: warn when a PR comment fails to post, and name the r...)
  ✔ Commit 1/3 (docs: show the report inline instead of linking four miss...)
  ✔ Commit 2/3 (fix: warn when a PR comment fails to post, and name the r...)
  ✔ Commit 3/3 (fix: handle a 403 whose body is not a JSON object)
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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

main_test.py (1)

1142-1151: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Assert the 403 error detail.

This test checks the permission hint, but it does not check Error: Resource not accessible. The implementation could remove the API error detail and this test would still pass. Add:

         self.assertIn("pull-requests: write", warning)
         self.assertNotIn("issues: write", warning)
+        self.assertIn("Resource not accessible", warning)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@main_test.py` around lines 1142 - 1151, Update
test_forbidden_names_the_permission_that_actually_grants_this to assert that the
warning output includes the API error detail “Error: Resource not accessible”,
while preserving the existing pull-requests permission assertion and issues
permission exclusion.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@main.py`:
- Around line 884-891: Update the 403 handling in add_pr_comments to normalize
GithubException.data before extracting an error message: only call get when the
payload is mapping-like, and otherwise fall back to str(e) or an equivalent safe
detail. Preserve the warning output and return 0 fallback, and add a regression
test covering a non-mapping 403 payload.

---

Nitpick comments:
In `@main_test.py`:
- Around line 1142-1151: Update
test_forbidden_names_the_permission_that_actually_grants_this to assert that the
warning output includes the API error detail “Error: Resource not accessible”,
while preserving the existing pull-requests permission assertion and issues
permission exclusion.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5396b4f7-30b6-4a33-ae80-b3cc371a1d53

📥 Commits

Reviewing files that changed from the base of the PR and between b97366c and d1a7d3a.

📒 Files selected for processing (5)

• README.md
• docs/fork-pr-comments.md
• examples/commit-check-workflow-a.yml
• main.py
• main_test.py