Skip to content

Commit

Permalink
Documentation update - add recommended permissions to Readme (#2043)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

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

---------

Co-authored-by: Josh Gross <joshmgross@github.com>
  • Loading branch information
benwells and joshmgross authored Jan 16, 2025
1 parent cbb7224 commit 009b9ae
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down

0 comments on commit 009b9ae

Please sign in to comment.