Skip to content

Commit 507420e

Browse files
committed
docs: Update to include app permissions needed to add teams as reviewers
1 parent 67df31e commit 507420e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
6060
| `labels` | A comma or newline-separated list of labels. | |
6161
| `assignees` | A comma or newline-separated list of assignees (GitHub usernames). | |
6262
| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
63-
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | |
63+
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). If using a GitHub App, refer to [Authenticating with GitHub App generated tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) for the proper permissions. | |
6464
| `milestone` | The number of the milestone to associate this pull request with. | |
6565
| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
6666

docs/concepts-guidelines.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,8 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
248248
- Uncheck `Active` under `Webhook`. You do not need to enter a `Webhook URL`.
249249
- Under `Repository permissions: Contents` select `Access: Read & write`.
250250
- Under `Repository permissions: Pull requests` select `Access: Read & write`.
251+
- Under `Organization permissions: Members` select `Access: Read-only`.
252+
- **NOTE**: Only needed if you would like add teams as reviewers to PRs.
251253

252254
2. Create a Private key from the App settings page and store it securely.
253255

0 commit comments

Comments
 (0)