Merge 0e208935da1975d9f58aa1581c473fb648ed24af into 009b9ae9e446ad8d9b8c809870b0fbcc5e03573e

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>
2026-01-12 23:23:07 +08:00 · 2025-01-16 11:42:09 -08:00 · 2025-01-16 14:14:48 -05:00
1 changed files with 10 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -323,6 +323,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
Author	SHA1	Message	Date
Guido Martínez	5a95956fa8	Merge 0e208935da1975d9f58aa1581c473fb648ed24af into 009b9ae9e446ad8d9b8c809870b0fbcc5e03573e	2025-01-16 11:42:09 -08:00
Ben Wells	009b9ae9e4	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>	2025-01-16 14:14:48 -05:00