From b7505897473be31dfbba0c51a018d8cbd9b69095 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Mon, 30 Dec 2019 11:10:22 +0900 Subject: [PATCH] Update README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 10d9700..ca0440b 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,17 @@ Note that in order to read the step output the action step must have an id. echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}" ``` +### Checkout + +This action expects repositories to be checked out with `actions/checkout@v2`. + +If there is some reason you need to use `actions/checkout@v1` the following step can be added to checkout the branch. + +```yml + - uses: actions/checkout@v1 + - run: git checkout "${GITHUB_REF:11}" +``` + ### Branch naming For branch naming there are two strategies. Create a fixed-name pull request branch that will be updated with new changes until it is merged or closed, OR, always create a new unique branch each time there are changes to be committed.