Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(github-token): add more details about the required permissions #1008

Merged
merged 2 commits into from
Mar 2, 2023
Merged

docs(github-token): add more details about the required permissions #1008

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35fbd8e
docs(typo): add missing plural on "pull request"
C0ZEN Mar 2, 2023
fa002fa
docs(github-token): add more details about the required permissions
C0ZEN Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion documentation/docs/05-github-token-input.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down