docs: drop the note that thread comments are disabled on private repositories - #492
Conversation
…sitories The `thread-comments` input said the feature is disabled on private repositories. cpp-linter has no such check any more: its requests ask for `application/vnd.github.raw+json`, which addressed #142, and nothing in `rest_api` looks at the repository's visibility. Following @2bndy5's suggestion on cpp-linter/cpp-linter.github.io#62, I ran the action on a private repository in the organization, cpp-linter/test-cpp-linter-action-private, with `thread-comments: update`: | Round | Push | Result | | --- | --- | --- | | 1 | code with one clang-format issue and two clang-tidy findings | github-actions[bot] posted one "Cpp-Linter Report" comment (run 36699441415) | | 2 | another function with findings | the same comment was edited (3 concerns); no second comment (run 36699583265) | | 3 | every finding fixed | the comment was deleted, as `no-lgtm: true` asks (run 36699719604) | All three runs passed, and their logs show no error from posting, editing or deleting the comment (the `##[warning]` lines are the file annotations for the findings). The workflow sets `permissions: pull-requests: write`; a repository whose default `GITHUB_TOKEN` is read-only needs that, as [documented](https://github.com/cpp-linter/cpp-linter-action/blob/main/docs/permissions.md). So the note is removed. The permissions note in `docs/permissions.md` (supply `GITHUB_TOKEN` on private repositories) stays; it is still true.
Cpp-Linter Report
|
6d570d2 to
51b957a
Compare
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review. WalkthroughThe ChangesThread-comments description
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change preserves thread-comment behavior and permission requirements. No actionable merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
The
thread-commentsinput said the feature is disabled on private repositories. cpp-linter has no such check any more: its requests ask forapplication/vnd.github.raw+json, which addressed #142, and nothing inrest_apilooks at the repository's visibility.Following @2bndy5's suggestion on cpp-linter/cpp-linter.github.io#62, I ran the action on a private repository in the organization, cpp-linter/test-cpp-linter-action-private, with
thread-comments: update:no-lgtm: trueasks (run 36699719604)All three runs passed, and their logs show no error from posting, editing or deleting the comment (the
##[warning]lines are the file annotations for the findings). The workflow setspermissions: pull-requests: write; a repository whose defaultGITHUB_TOKENis read-only needs that, as documented.So the note is removed. The permissions note in
docs/permissions.md(supplyGITHUB_TOKENon private repositories) stays; it is still true.Summary by CodeRabbit
thread-commentsinput description by removing the note about private-repository limitations. No input settings or defaults changed.