diff options
| author | Ben Wells <benwells@github.com> | 2025-01-16 14:14:48 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-16 14:14:48 -0500 |
| commit | ba0c1d98889b0d5fbc0f24c82d2935387035cc68 (patch) | |
| tree | d46b7d1a7268f3104564735cf8bc64ef5ab21f2f | |
| parent | 41a008c081c2d47c14055c4e1bb91af2a27b2899 (diff) | |
Documentation update - add recommended permissions to Readme (#2043)
* Update README.md
* Update README.md
Co-authored-by: Josh Gross <joshmgross@github.com>
---------
Co-authored-by: Josh Gross <joshmgross@github.com>
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -311,6 +311,16 @@ jobs: git commit -m "generated" git push ``` + +## Recommended permissions + +When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs: + +```yaml +permissions: + contents: read +``` + *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D |