Skip to content

Commit 562d03e

Browse files
committed
doc: add detailled only-new-issues explanation
1 parent f1589ca commit 562d03e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,6 @@ with:
137137

138138
Show only new issues.
139139

140-
If you are using `merge_group` event (merge queue) you should add the option `fetch-depth: 0` to `actions/checkout` step.
141-
142140
The default value is `false`.
143141

144142
```yml
@@ -148,6 +146,11 @@ with:
148146
# ...
149147
```
150148

149+
* `pull_request` and `pull_request_target`: the action gets the diff of the PR content from the [GitHub API](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request) and use it with `--new-from-patch`.
150+
* `push`: the action gets the diff of the push content (difference between commits before and after the push) from the [GitHub API](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits) and use it with `--new-from-patch`.
151+
* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
152+
You should add the option `fetch-depth: 0` to `actions/checkout` step.
153+
151154
### `working-directory`
152155

153156
(optional)

0 commit comments

Comments
 (0)