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.
This commit is contained in:
Max Held 2019-08-13 16:53:03 +02:00 committed by Ting
parent af513c7a01
commit b4b537b06a

@ -2,6 +2,9 @@
This action checks out your repository so that your workflow operates from the root of the repository 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 # Usage
See [action.yml](action.yml) See [action.yml](action.yml)