docs: add explanation for github-token option

This commit is contained in:
Fernandez Ludovic 2024-05-20 18:31:17 +02:00
parent 8a8f91e859
commit bc05d62e37

View File

@ -154,6 +154,21 @@ with:
* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
You should add the option `fetch-depth: 0` to `actions/checkout` step.
### `github-token`
(optional)
When using `only-new-issues` option, the GitHub API is used, so a token is required.
By default, it uses the `github.token` from the action.
```yml
uses: golangci/golangci-lint-action@v6
with:
github-token: xxx
# ...
```
### `working-directory`
(optional)