actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2025-10-31 05:25:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update - add recommended permissions to Readme (#2043)

Browse Source 
* Update README.md

* Update README.md

Co-authored-by: Josh Gross <joshmgross@github.com>

---------

Co-authored-by: Josh Gross <joshmgross@github.com>
This commit is contained in:
Ben Wells
2025-01-16 14:14:48 -05:00
committed by GitHub
parent cbb722410c
commit 009b9ae9e4
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -311,6 +311,16 @@ jobs:
git commit -m "generated" git commit -m "generated"
git push 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 *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