fix: add issues: read permissions for pr-comments

[shenxianpeng]

closes #143

Summary by CodeRabbit

• Documentation

  • Updated usage examples to clarify required permissions, including the issues: read permission for pull request functionality.
  • Expanded the optional inputs section with detailed guidance on configuring GitHub Actions permissions.

• Chores

  • Updated workflow configuration for consistency and clarity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request adds the issues: read permission to GitHub Actions workflow and documentation. This addresses a 403 error encountered when posting PR comments, as GitHub's API treats pull requests as issues requiring explicit permission access.

Changes

Cohort / File(s)	Change Summary
Workflow permissions .github/workflows/commit-check.yml	Modified pull_request branch from string "main" to array ["main"]; added issues: read permission to permissions block alongside existing contents: read and pull-requests: write
Documentation updates README.md	Added issues: read to permissions example in usage section; expanded pr-comments optional input description with multi-line bullet list explaining GITHUB_TOKEN setup and issues: read permission requirement for Issues API access

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Straightforward permission additions with matching updates across workflow and documentation
• Changes follow consistent pattern (adding same permission in two places)
• No logic or behavioral modifications

Possibly related issues

• Error posting PR comment: Resource not accessible by integration: 403 #143: Directly addresses the root cause of "Error posting PR comment: Resource not accessible by integration: 403" by adding required issues: read permission for PR comment posting via GitHub Issues API

Suggested labels

skip-changelog

Poem

🐰 A permission was missing, the API said "no,"
But now with issues: read, the PRs can flow!
Both workflow and docs now sing in harmony,
No more 403s—just smooth delivery! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch patch-1

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e021a9 and 3059b33.

📒 Files selected for processing (2)

• .github/workflows/commit-check.yml (1 hunks)
• README.md (2 hunks)

---

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 and usage tips.}

[github-actions]

Commit-Check ❌

Commit rejected by Commit-Check.                                  
                                                                  
  (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)  
   / ._. \      / ._. \      / ._. \      / ._. \      / ._. \   
 __\( C )/__  __\( H )/__  __\( E )/__  __\( C )/__  __\( K )/__ 
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
   || E ||      || R ||      || R ||      || O ||      || R ||   
 _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._ 
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
 `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´ 
                                                                  
Commit rejected.                                                  
                                                                  
Type branch check failed ==> patch-1 
It doesn't match regex: ^(feature|bugfix|hotfix|release|chore|feat|fix)\/.+|(master)|(main)|(HEAD)|(PR-.+)
The branch should follow Conventional Branch. See https://conventional-branch.github.io/
Suggest: Use <type>/<description> with allowed types or ignore_authors in config branch section to bypass

[Copilot]

Pull Request Overview

This PR adds the missing issues: read permission required for the pr-comments feature to function properly. Since GitHub's Pull Request API uses the Issues API under the hood, this permission is necessary for reading and commenting on pull requests.

• Added issues: read permission to workflow examples and configuration
• Updated documentation to clearly explain the permission requirement
• Normalized YAML array syntax in workflow configuration

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
README.md	Added issues: read permission to the example workflow and updated the pr-comments documentation to list the permission as a requirement
.github/workflows/commit-check.yml	Added issues: read permission to the actual workflow and normalized the branches array syntax

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.