From 5ea31358e901bfaf28ca19849903d802fd0a891b Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Tue, 1 Sep 2020 09:15:45 +0900 Subject: [PATCH] docs: updates related to checkout --- README.md | 4 ++++ docs/concepts-guidelines.md | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6077b24..0284222 100644 --- 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 index 2465527..f4694a7 100644 --- 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.