Document GITHUB_TOKEN permissions needed explicitely
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
It would be helpful to document explicitely in README.md what GITHUB_TOKEN permissions must be granted.
The actions/setup-go (which uses actions/cache) recommends contents: read but I would like to be sure that, as a user of setup-go I don't need to grant more permissions (or better if I could remove some).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing README.md and the documented permission guidance for actions/setup-go and actions/cache, especially the contents: read recommendation. Verify which GITHUB_TOKEN permissions are actually required, then update README.md to state the minimum permissions clearly and confirm the documentation answers whether any permissions can be removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100