Replies: 1 comment
-
It's partially documented here: metrics/.github/readme/partials/documentation/setup/action.md Lines 25 to 32 in c895cb0 But it's true that it's still pretty vague. The optional scopes you listed are most of the time appended automatically by the docs generator Like I'm pretty confident that anything related to org requires |
Beta Was this translation helpful? Give feedback.
-
Right now, a README of a plugin may have something alongside this in their "Supported specifications" section:
🔑 (scopeless)
read:org (optional)
read:user (optional)
read:packages (optional)
repo (optional)
While it shows what is and isn't required, does it not really tell you what each scope's purpose here would be.
What would
read:org
achieve for this plugin?If I want to have repos of another org listed, do I only need a token with
read:org
, one withrepo
or both?So, it could be a good idea to add a section within the README file to explain any listed scope and their purpose when used.
It would help reduce general confusion, especially for people who have no understanding of tokens, their scope and what is and isn't required for their needs.
Beta Was this translation helpful? Give feedback.
All reactions