From bc05d62e370fab106ba82f20c1a0b66c31fd49f0 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Mon, 20 May 2024 18:31:17 +0200 Subject: [PATCH] docs: add explanation for github-token option --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 931e80b..8b42413 100644 --- a/README.md +++ b/README.md @@ -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)