Skip to content

Commit

Permalink
doc: add detailled only-new-issues explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez committed May 4, 2024
1 parent f1589ca commit 661123e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,6 @@ with:

Show only new issues.

If you are using `merge_group` event (merge queue) you should add the option `fetch-depth: 0` to `actions/checkout` step.

The default value is `false`.

```yml
Expand All @@ -148,6 +146,11 @@ with:
# ...
```

* `pull_request` and `pull_request_target`: the action will get 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`.
* `push`: the action will get 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`.
* `merge_group`: the action will get the diff by using `--new-from-rev` option (relies on git).
You should add the option `fetch-depth: 0` to `actions/checkout` step.

### `working-directory`

(optional)
Expand Down

0 comments on commit 661123e

Please sign in to comment.