amannn / amannn/action-semantic-pull-request
docs: miss permission for statuses: write
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 154
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
It's not really a feature, but I was unable to make the action work with only permissions.pull-requests: read.
I had to add permissions.statuses: write. Indeed, after trying a lot of combinations, I tried permissions: write-all and noticed a new status check added.
I don't know why I seem to be the only one though 🤔 The action runs in a public repo with the Action GITHUB_TOKEN.
Describe the solution you'd like
Add the mention in the docs. I'm willing to open a doc PR if you agree!
Describe alternatives you've considered
None.
Contributor guide
No contributing guide indexed for this repository
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
No file or test is named. Start by locating the documentation for configuring the action's GITHUB_TOKEN permissions, then verify where the required statuses: write permission should be documented. Done means the permission requirement is clearly mentioned for users configuring the action.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100