From 2b2b6d210d0238526097f60d428ff00a46b9acf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Z=C3=BClke?= Date: Wed, 9 Jul 2025 15:34:44 +0200 Subject: [PATCH] Document outputs in README.md And use ref, not sha, for the PR checkout example, so that the checkout does not result in a detached HEAD. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8969446..be08890 100644 --- a/README.md +++ b/README.md @@ -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: