From a14471d838f6a7ce15cab8740f25e337c51e7cad Mon Sep 17 00:00:00 2001 From: Max Held Date: Thu, 22 Aug 2019 03:39:05 +0200 Subject: [PATCH] clarify language on working directory (#9) * clarify language I guess this action doesn't technically make sure that my working directory is `$GITHUB_WORKSPACE`, so this might be more precise? * fix repetition --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a52b55..d847f7c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # checkout -This action checks out your repository so that your workflow operates from the root of the repository +This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository. By default, this is equivalent to running `git fetch` and `git checkout $GITHUB_SHA`, so that you'll always have your repo contents at the version that triggered the workflow. See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events.