Skip to content

Commit

Permalink
document additional token requirements for project owners
Browse files Browse the repository at this point in the history
  • Loading branch information
yasunariw committed Mar 1, 2023
1 parent 3be7fa1 commit 6bf03bc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Run the `_build/default/src/monorobot.exe` binary. The following commands are su
2. Place a **secrets** file locally on the server.
3. Configure GitHub
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.
To use the "Project Owners" feature, the token owner must have write access to the repository.
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`.
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.
4. Configure Slack
Expand Down
6 changes: 5 additions & 1 deletion documentation/config_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,11 @@ Draft PR behavior is similar to code owners. From GitHub documentation:
The syntax for listing users is `username`. For teams, it is `org/team-name`.

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.
Some prerequisites apply to using this feature.

1. The owner of the personal access token must have write access to the repository.
2. 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.

```json
{
Expand Down

0 comments on commit 6bf03bc

Please sign in to comment.