Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Add requested permissions #492

Merged
merged 9 commits into from
Jun 14, 2021
Merged

Conversation

flaxel
Copy link
Contributor

@flaxel flaxel commented Jun 7, 2021

Changes

  • add required permissions

Context

Everybody knows which permissions are required for the action.

closes #491

@flaxel flaxel requested a review from a team as a code owner June 7, 2021 19:13
@flaxel flaxel changed the title 📝 add requested permissions 📝 Add requested permissions Jun 7, 2021
Copy link
Contributor

@C0ZEN C0ZEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it cannot be fun at all to do, but I think we should not present this as the required permissions and instead present this as the recommanded ones.
Then for each option, just below the default value, mention if this will require a specific permission(s).
It gives transparency and also security insights.

Copy link
Contributor

@C0ZEN C0ZEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lastly, I think it's worth suggesting a version with all the possible permissions so that if people don't care about security and wish to don't bother with this they still can (better than saying: enable everything mate!).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Geoffrey Testelin <[email protected]>
Copy link
Contributor

@C0ZEN C0ZEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flaxel
Copy link
Contributor Author

flaxel commented Jun 8, 2021

image

@luketomlinson luketomlinson merged commit 92d4fc6 into actions:main Jun 14, 2021
@flaxel flaxel deleted the update-readme branch June 14, 2021 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for GITHUB_TOKEN required permissions
3 participants