actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2025-07-13 18:56:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

Document outputs in README.md

Browse source 
And use ref, not sha, for the PR checkout example, so that the checkout does not result in a detached HEAD.
This commit is contained in:
David Zülke 2025-07-09 15:34:44 +02:00 • committed by GitHub
parent 09d2acae67
commit 2b2b6d210d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -265,12 +265,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
> - `${{ github.token }}` is scoped to the current repository, so if you want to checkout a different repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
## Checkout pull request HEAD commit instead of merge commit
## Checkout pull request HEAD instead of merge commit
```yaml
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
ref: ${{ github.event.pull_request.head.ref }}
```
## Checkout pull request on closed event
@ -332,6 +332,12 @@ jobs:
*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
# Outputs
The `checkout` action provides the following outputs that can be referenced in later steps:
- `ref`, the Git ref that was checked out (not available if the checkout resulted in a detached `HEAD`)
- `sha`, the SHA of the commit that was checked out
# 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: