docs: updates related to checkout

peter-evans · Sep 1, 2020 · 5ea3135 · 5ea3135
1 parent 105f0d3
commit 5ea3135
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -26,6 +26,10 @@ Create Pull Request action will:
 ## Usage
 
 ```yml
+      - uses: actions/checkout@v2
+
+      # Make changes to pull request here
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v3
 ```

diff --git a/docs/concepts-guidelines.md b/docs/concepts-guidelines.md
@@ -29,7 +29,8 @@ A pull request references two branches:
 
 ## Events and checkout
 
-For each [event type](https://docs.github.com/en/actions/reference/events-that-trigger-workflows) there is a default `GITHUB_SHA` that will be checked out by the GitHub Actions [checkout](https://github.com/actions/checkout) action.
+This action expects repositories to be checked out with the official GitHub Actions [checkout](https://github.com/actions/checkout) action.
+For each [event type](https://docs.github.com/en/actions/reference/events-that-trigger-workflows) there is a default `GITHUB_SHA` that will be checked out.
 
 The default can be overridden by specifying a `ref` on checkout.