浏览代码

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.
Max Held 5 年之前
父节点
当前提交
b4b537b06a
共有 1 个文件被更改,包括 3 次插入0 次删除
  1. 3 0
      README.md

+ 3 - 0
README.md

@@ -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)