foo-software / lighthouse-check-action

GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!
https://github.com/marketplace/actions/lighthouse-check
MIT License
478 stars 24 forks source link

Specify which permissions need to be set for the access token (repo > public_repo) in docs #36

Closed lukasoppermann closed 3 years ago

lukasoppermann commented 4 years ago

If you can let me know what is needed, I can send a PR to the docs.

lukasoppermann commented 4 years ago

As far as I have figured out you only need the "repo > public_repo" scope in the personal access token

adamhenson commented 4 years ago

Hey @lukasoppermann - thanks for opening this. The token permission isn’t specific to this GitHub action. These permissions are whatever GitHub API requires to post comments. Since it’s not specific to this project I’d hesitate to add these details since they could change in the future. I think it might be nice to provide a link to where this is documented in the API, but to be honest I’m not even sure myself. If you can find this documentation and open a PR to link to it, I’d be grateful. I do remember having a hard time finding it and maybe just ended up guessing. I’ll try again and will post here if I find it.

adamhenson commented 4 years ago

This is the documentation for the GitHub API endpoint we use. I'm using repo and write:discussion scopes, however I might only need repo. Additional scopes might be relevant depending on circumstances. We might just want to link to the OAuth scope documentation and hint that they will most likely need repo scope set on the token at minimum.

adamhenson commented 4 years ago

Important to note - not everyone will want or need public_repo scope.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.