codecov / codecov/codecov-action
Adjust readme regarding OIDC auth
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 260
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 1
Description
The readme shows the example:
permissions:
id-token: write
But that is missing a read permission that would cause the action to be unable to checkout the repo.
It would be better to show a fuller example:
permissions:
contents: read # For actions/checkout
id-token: write # For Codecov OIDC
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
Find the README section showing the GitHub Actions OIDC permissions example. Update it to include contents: read for actions/checkout alongside id-token: write for Codecov OIDC, then review the rendered example to confirm both permissions and comments are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100