diff --git a/documentation/docs/05-github-token-input.mdx b/documentation/docs/05-github-token-input.mdx index 8d1fce818..0d468e7da 100644 --- a/documentation/docs/05-github-token-input.mdx +++ b/documentation/docs/05-github-token-input.mdx @@ -25,11 +25,21 @@ You can also read the [automatic token authentication](https://docs.github.com/e Based on your configuration, make sure to give the proper [permissions](https://docs.github.com/en/rest/reference/permissions-required-for-github-apps) to your GitHub token. If not, you may end up having weird behaviours, where some data will be missing from the queries. -Note that if you have unusual behaviours, a debug log is exposing the queried data from your issues and pull request. +Note that if you have unusual behaviours, a debug log is exposing the queried data from your issues and pull requests. This may be very helpful to debug your workflow, before creating a [new issue](https://github.com/Sonia-corporation/stale/issues/new/choose). ::: +The minimum permissions are: + +- contents: _read_ + +And based on your configuration, you have a great chance to also need: + +- issues: _write_ +- pull-requests: _write_ +- repository-projects: _read_ + :::info Under the hood, the value will be consumed by the [@actions/github](https://github.com/actions/toolkit/tree/main/packages/github), through the [getOctokit method](https://github.com/actions/toolkit/blob/fcb8c4ca798bd0d81a9b07e2f7dffee8397c4707/packages/github/src/github.ts#L15-L20).