Add the needed permissions/scopes to the custom action documentation

[rajbos]

TL;DR

The document does not state the necessary scopes for the authentication to GitHub, which leads to a permissions error on runtime (which also does not show the necessary scopes needed).

I would expect that info in the README here.

Expected behavior

Documentation indicates the scopes that are needed

Observed behavior

No response

Version

main

On which operating system are you using legitify?

Linux

Relevant log output

Running on a single repo:

legitify failed with:
Using Github Cloud
Error: repository <org>/<repo> insufficient permissions

No response

Additional information

No response

[noamd-legit]

Hi @rajbos

We mention in the readme the following scopes:

admin:org, read:enterprise, admin:org_hook, read:org, repo, read:repo_hook

Did you mean something else?

[rajbos]

@noamd-legit , that is for the run on the org level, indeed. I would also recommend to add the necessary permissions for when running in the current repo. It is possible to run this action with just the GITHUB_TOKEN if you want to, correct? Add those permissions with the permissions keyword to the example?

[noamd-legit]

Yeah you can use GITHUB_TOKEN for the action but only when running for the current repository otherwise it will fail.
I'll clarify in the readme

Thank you!

[noamd-legit]

@rajbos I reverified the behavior, unfortunately currently GITHUB_TOKEN is not supported by the action since legitify requires access to https://api.github.com/user/orgs API

I opened a feature request here: #265