Skip to content

Commit

Permalink
doc: update token section
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Nov 9, 2023
1 parent cb8a3f9 commit 6cee247
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ jobs:
runs-on: ubuntu-latest

permissions:
issues: write
pull-requests: write

steps:
Expand Down Expand Up @@ -202,7 +201,7 @@ Action currently accepts the following options:
with:
pr-number: <number>
config-path: <path to config file>
token: <GitHub token>
token: <GitHub token or PAT>
# ...
```
Expand All @@ -223,7 +222,14 @@ Path to configuration file. Configuration file format is described in: [Policy s

### token

Token used to create comments. Minimal required permissions are `contents: read` and `pull-requests: write`
GitHub token or PAT is used for creating comments on Pull Request.

```yml
# required permission
permissions:
contents: read
pull-requests: write
```

* default value: `undefined`
* requirements: `required`
Expand Down

0 comments on commit 6cee247

Please sign in to comment.