Skip to content

docs: include contents: read in the README action example - #84

Merged
2 commits merged into
mainfrom
docs/action-permissions
Sep 27, 2026
Merged

2 commits merged into
mainfrom
docs/action-permissions

Conversation

@vitali87

Copy link
Copy Markdown
Owner

Problem

The README's GitHub Action example declares only permissions: pull-requests: write. A top-level permissions block replaces the token's default scopes entirely, so contents becomes none and actions/checkout (plus the script's git fetch origin <base> / refs/pull/N/head) fails on private repos. The repo's own .github/workflows/split-score.yml already declares contents: read.

Change

Add contents: read to the example block. Docs only.

Local review: 5/5 (also re-verified every input/output/default in the README action tables against action.yml — all match).

Setting any permission in a workflow resets the others to none, so the
example's pull-requests: write alone leaves actions/checkout without
read access on private repos. The repo's own split-score.yml already
includes contents: read.
@coderabbitai

coderabbitai Bot commented Aug 30, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 42 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 380e7d84-cc13-46f0-9270-350756a78dc5

📥 Commits

Reviewing files that changed from the base of the PR and between 671a081 and fb4377d.

📒 Files selected for processing (1)
  • README.md

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.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015rnEEjXWDBdePRhKMmZr1w
@vitali87 vitali87 closed this pull request by merging all changes into main in 8ca9e3b Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants