Add Recommended Permissions #665
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To reduce risk of over-privileged tokens, we are adding recommended permissions to popular GitHub-owned Actions READMEs
joshmgross
reviewed
Feb 12, 2025
|
|
||
| # Recommended Permissions | ||
|
|
||
| The `actions/upload-artifact` workflow relies on an internal authentication pattern and does not use the GITHUB_TOKEN, to reduce risk of over-privileged token, jobs that use `actions/upload-artifact` should set permissions to none: |
There was a problem hiding this comment.
Same feedback as cache and download-artifact - actions/download-artifact#373 (comment)
There was a problem hiding this comment.
I think best practice is to set permissions at the top to minimal (none or contents: read for example), and then add permissions needed in each job.
See the wording in "remediation steps" for example on the ossf scorecard: https://github.com/ossf/scorecard/blob/7ce8609469289d5f3b1bf5ee3122f42b4e3054fb/docs/checks.md#token-permissions
Agreed that the proposed wording without links to more detailed documentation might break things for people.
Some docs explaining the permissions required would be good, and pointers to more detailed documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To reduce risk of over-privileged tokens, we are adding recommended permissions to popular GitHub-owned Actions READMEs. Please confirm these permissions are correct and merge the change. Thank you!