From 18cc0b2b98e6cf3a9bca5c162fc2755915e65bfb Mon Sep 17 00:00:00 2001 From: Jason Karns Date: Mon, 11 Nov 2019 10:04:20 -0500 Subject: [PATCH] Clarify that ref checkouts are Detached HEAD --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd5c031..432afdd 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ steps: - run: npm test ``` -By default, the branch or tag ref that triggered the workflow will be checked out, `${{ github.token }}` will be used for any Git server authentication. If you wish to check out a different branch, a different repository or use different token to checkout, specify that using `with.ref`, `with.repository` and `with.token`: +By default, the sha for the given branch or tag ref that triggered the workflow will be checked out, (leaving the repository in detached HEAD state). `${{ github.token }}` will be used for any Git server authentication. If you wish to check out a different branch, a different repository or use a different token to checkout, specify that using `with.ref`, `with.repository` or `with.token` respectively: Checkout different branch from the workflow repository: ```yaml