Indicate required permissions #122
Description
Please describe your suggestion: 提案の概要
This action uses API that fetch the status of other workflow step, as far as I can tell this requires actions: read permission.
The documentation should mention the required permissions to run this action.
Describe the solution you'd like: 考えうる解決方法
Add a "troubleshooting" section in the README, maybe in the form of an FAQ, something like:
Why am I receiving this error
[HttpError]: Resource not accessible by integration?You are probably specifying permissions in your workflow, make sure to add
actions: read.In your workflow file:
permissions: actions: read
Describe alternatives you've considered: 考えうる代替案
Handle this specific error case in the code and suggest updating the permissions right from the action's log.
Additional context: 補足
When I first tried this action it would fail with this error:
After a little bit of digging, I noticed that it was using this API to fetch workflow job, that according to its documentation requires the actions: read permission.
It turns out that I was setting explicit permissions in my workflow and after adding actions: read it started working as expected.
Thank you for this action btw 🙏