diff options
| author | Max Held <info@maxheld.de> | 2019-08-13 16:53:03 +0200 |
|---|---|---|
| committer | Ting <huangtingluo@gmail.com> | 2019-08-13 10:53:03 -0400 |
| commit | 34a86871a1f35bc9f135edc7c1a022f726230bc5 (patch) | |
| tree | 44a965510695fc0caa9096269655887175991198 | |
| parent | 5820cf2241935bf3a8a128b891463292a8d6df49 (diff) | |
clarify default checkout sha (#10)
this is trivial for `on: push`, but might be helpful to remind readers that this ain't always so for other events.
Hence the link to the docs.
| -rw-r--r-- | README.md | 3 |
1 files changed, 3 insertions, 0 deletions
@@ -2,6 +2,9 @@ This action checks out your repository so that your workflow operates from the root of the 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 `$GITHUBS_SHA` is for different kinds of events. + # Usage See [action.yml](action.yml) |