Documentation Update - add permissions section to readme #511
Conversation
This file contains 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
benwells
temporarily deployed
to
debug-integration-test
GitHub Actions
Inactive
|
Hello from actions/github-script! (3e760d5) |
joshmgross
reviewed
Jan 16, 2025
Comment on lines
+149
to
+153
| ### General Best Practices | ||
|
|
||
| - Use the principle of least privilege: Only grant the specific permissions needed for your workflow. | ||
| - Regularly audit and review your workflows to ensure permissions remain appropriate for your use cases. | ||
| - Test your workflows with the intended permissions to verify they work as expected without over-permissioning. |
There was a problem hiding this comment.
I'd remove this section personally - this would be betters suited in our GitHub documentation for Actions best practices rather than in this action's README.
Comment on lines
+135
to
+147
| ## Recommended Permissions | ||
|
|
||
| The permissions required for the `GITHUB_TOKEN` in your workflow vary depending on how you use `github-script`. To ensure secure and efficient use of this action, we recommend reviewing and setting the least privileges necessary for your use case. | ||
|
|
||
| ### Determine the Required Permissions | ||
|
|
||
| 1. **`GITHUB_TOKEN` Authentication** | ||
| GitHub automatically provides a `GITHUB_TOKEN` for workflows. You can customize the permissions granted to this token. Refer to the documentation for details: | ||
| [Permissions for the `GITHUB_TOKEN`](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) | ||
|
|
||
| 2. **API Calls with Installation Access Tokens** | ||
| If you're using `github-script` to make API calls requiring installation access tokens, ensure the permissions are configured appropriately for those endpoints. Learn more here: | ||
| [Permissions for installation access tokens](https://docs.github.com/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens) |
There was a problem hiding this comment.
I think we can simplify this a bit
Suggested change
| ## Recommended Permissions | |
| The permissions required for the `GITHUB_TOKEN` in your workflow vary depending on how you use `github-script`. To ensure secure and efficient use of this action, we recommend reviewing and setting the least privileges necessary for your use case. | |
| ### Determine the Required Permissions | |
| 1. **`GITHUB_TOKEN` Authentication** | |
| GitHub automatically provides a `GITHUB_TOKEN` for workflows. You can customize the permissions granted to this token. Refer to the documentation for details: | |
| [Permissions for the `GITHUB_TOKEN`](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) | |
| 2. **API Calls with Installation Access Tokens** | |
| If you're using `github-script` to make API calls requiring installation access tokens, ensure the permissions are configured appropriately for those endpoints. Learn more here: | |
| [Permissions for installation access tokens](https://docs.github.com/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens) | |
| ## Recommended permissions | |
| The permissions required for the `GITHUB_TOKEN` in your workflow vary depending on how you use `actions/github-script`. We recommend reviewing and setting the least privileges necessary for your use case. | |
| See [Permissions for the `GITHUB_TOKEN`](https://docs.github.com/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) for details on the available permissions and [Permissions for installation access tokens](https://docs.github.com/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens) for information on what permissions each API requires. |
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.
Add new Recommended permissions section to the README file.