Skip to content

Commit

Permalink
docs: add info on multi-repo setup
Browse files Browse the repository at this point in the history
  • Loading branch information
yasunariw committed Dec 3, 2021
1 parent d08251b commit 3e47dde
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Note: The `slack_access_token` must be configured in your secrets file for link

### Documentation

The bot expects two configuration files to be present.
Commit a configuration file to the root of each repository you want to support, and add a secrets file on the bot server itself. Read on for instructions to set up each file:

* [Repository configuration](./documentation/config_docs.md)
* [Secrets](./documentation/secret_docs.md)
Expand Down
30 changes: 30 additions & 0 deletions documentation/secret_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ A secrets file stores sensitive information. Unlike the repository configuration
|-|-|-|-|
| `gh_token` | specify to grant the bot access to private repositories; omit for public repositories | Yes | - |
| `gh_hook_token` | specify to ensure the bot only receives GitHub notifications from pre-approved repositories | Yes | - |
| `repos` | an object mapping repository URLs to repository-specific GitHub secrets | Yes | - |
| `allowed_repos` | a whitelist of repository URLs to process payloads for | Yes | all incoming payloads are processed |
| `slack_access_token` | slack bot access token to enable message posting to the workspace | Yes | try to use webhooks defined in `slack_hooks` instead |
| `slack_hooks` | list of channel names and their corresponding webhook endpoint | Yes | try to use token defined in `slack_access_token` instead |
| `slack_signing_secret` | specify to verify incoming slack requests | Yes | - |
Expand All @@ -27,10 +29,38 @@ Note that either `slack_access_token` or `slack_hooks` must be defined. If both

Some operations, such as fetching a config file from a private repository, or the commit corresponding to a commit comment event, require a personal access token. Refer [here](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) for detailed instructions on token generation.

*See `repos` if you need to support multiple repositories that use different tokens.*

## `gh_hook_token`

Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks) for more information on securing webhooks with a token.

*See `repos` if you need to support multiple repositories that use different tokens.*

## `repos`

If you're using Monorobot for multiple repositories that need different secrets (e.g., one on github.com and another on GitHub Enterprise), you can provide them as an object. Secrets defined here will take precedence over those defined at the top level of the secrets file.

Repository URLs should be fully qualified (include the protocol), with no trailing backslash.

```json
{
"https://github.com/ahrefs/runner" : {
"gh_token": "XXX"
},
"https://git.ahrefs.com/ahrefs/coyote" : {
"gh_token": "XXX",
"gh_hook_token": "XXX"
}
}
```

## `allowed_repos`

Use this option to restrict incoming notifications from GitHub to approved repository URLs.

Repository URLs should be fully qualified (include the protocol), with no trailing backslash.

## `slack_access_token`

Required for:
Expand Down

0 comments on commit 3e47dde

Please sign in to comment.