From b4b537b06a577732e04b29acc7294f645c135da0 Mon Sep 17 00:00:00 2001 From: Max Held Date: Tue, 13 Aug 2019 16:53:03 +0200 Subject: [PATCH] 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. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a5da491..fe28f75 100644 --- a/README.md +++ b/README.md @@ -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)