Skip to content

Commit 6bf03bc

Browse files
committed
document additional token requirements for project owners
1 parent 3be7fa1 commit 6bf03bc

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Run the `_build/default/src/monorobot.exe` binary. The following commands are su
3333
2. Place a **secrets** file locally on the server.
3434
3. Configure GitHub
3535
1. If targeting a private repository, set up a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with `repo` scope and store it in the `gh_token` field of the secrets file.
36+
To use the "Project Owners" feature, the token owner must have write access to the repository.
3637
2. [Create a webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/creating-webhooks#setting-up-a-webhook) for the repository you are targeting. Set the *Payload URL* to be `<server_domain>/github`.
3738
3. You can optionally [secure the webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks) with a token, and store it in the `gh_hook_token` field of the secrets file.
3839
4. Configure Slack

documentation/config_docs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,11 @@ Draft PR behavior is similar to code owners. From GitHub documentation:
260260
261261
The syntax for listing users is `username`. For teams, it is `org/team-name`.
262262

263-
Note that the owner of the personal access token cannot be a project owner, as GitHub disallows a user from self-requesting a review. Consider provisioning a separate bot user, or authenticating using a [GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#accessing-api-endpoints-as-a-github-app) instead.
263+
Some prerequisites apply to using this feature.
264+
265+
1. The owner of the personal access token must have write access to the repository.
266+
2. The owner of the personal access token cannot be a project owner, as GitHub disallows a user from self-requesting a review.
267+
Consider provisioning a separate bot user, or authenticating using a [GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#accessing-api-endpoints-as-a-github-app) instead.
264268

265269
```json
266270
{

0 commit comments

Comments
 (0)