Compare commits

...

4 commits

Author SHA1 Message Date
ADTC
007a9d3161
Merge a8f4e23084 into 85e6279cec 2025-01-24 11:48:20 -05:00
Josh Gross
85e6279cec
Adjust positioning of user email note and permissions heading (#2044)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
Licensed / Check licenses (push) Has been cancelled
Build and Test / build (push) Has been cancelled
Build and Test / test (macos-latest) (push) Has been cancelled
Build and Test / test (ubuntu-latest) (push) Has been cancelled
Build and Test / test (windows-latest) (push) Has been cancelled
Build and Test / test-proxy (push) Has been cancelled
Build and Test / test-bypass-proxy (push) Has been cancelled
Build and Test / test-git-container (push) Has been cancelled
Build and Test / test-output (push) Has been cancelled
2025-01-16 15:56:18 -05: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
ADTC
a8f4e23084
Add to README how to checkout PR in issue_comment event
Closes #331
2023-03-27 01:42:09 +08:00

View file

@ -142,6 +142,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
- [Checkout pull request on `issue_comment` event](#Checkout-pull-request-on-issue_comment-event)
- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
@ -269,6 +270,16 @@ jobs:
- uses: actions/checkout@v4
```
## Checkout pull request on `issue_comment` event
**Note:** The job must check if the issue is a pull request using `if: github.event.issue.pull_request` which skips it otherwise.
```yaml
- uses: actions/checkout@v3
with:
ref: refs/pull/${{ github.event.issue.number }}/head
```
## Push a commit using the built-in token
```yaml
@ -311,8 +322,17 @@ jobs:
git commit -m "generated"
git push
```
*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
# 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
```
# License