Read-only mirror — the public repositories of the Forgejo instance, refreshed every 10 minutes. The live instance (fg.dieschoenewolke.de) is reachable only over the VPN; clone here with https://git.dieschoenewolke.de/git/<owner>/<repo>.git.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMax Held <info@maxheld.de>2019-08-22 03:39:05 +0200
committerTingluo Huang <tingluohuang@github.com>2019-08-21 21:39:05 -0400
commitdf8410bcaef5b72c336f1ad34a6e633a62849164 (patch)
tree4dee6d49246cb206911a80b4a5e264f41205099c /README.md
parent1f3a9e812d68bca781a7d250b9dc90c881647577 (diff)
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
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
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.