Skip to content

Commit da6a868

Browse files
committed
docs: update readme
1 parent cbd5e97 commit da6a868

File tree

1 file changed

+1
-11
lines changed

1 file changed

+1
-11
lines changed

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,6 @@ Note that in order to read the step output the action step must have an id.
7373
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
7474
```
7575

76-
### Checkout
77-
78-
This action expects repositories to be checked out with `actions/checkout@v2`.
79-
80-
If there is some reason you need to use `actions/checkout@v1` the following step can be added to checkout the branch.
81-
82-
```yml
83-
- uses: actions/checkout@v1
84-
- run: git checkout "${GITHUB_REF:11}"
85-
```
86-
8776
### Action behaviour
8877

8978
The default behaviour of the action is to create a pull request that will be continually updated with new changes until it is merged or closed.
@@ -115,6 +104,7 @@ To use this strategy, set input `branch-suffix` with one of the following option
115104
### Controlling commits
116105

117106
As well as relying on the action to handle uncommitted changes, you can additionally make your own commits before the action runs.
107+
Note that the repository must be checked out on a branch with a remote, it won't work for [events which checkout a commit](docs/concepts-guidelines.md#events-which-checkout-a-commit).
118108

119109
```yml
120110
steps:

0 commit comments

Comments
 (0)