docs(readme): move configuration to separate section
This commit is contained in:
parent
28dfe8c61a
commit
0b06645e1d
17
README.md
17
README.md
|
@ -4,11 +4,7 @@ A webhook filter for [Deno](https://deno.land/) that filters GitHub events befor
|
|||
forwarding them to a Discord webhook, reducing noise.
|
||||
Additionally, it attempts to handle Discord ratelimits and resend the webhook events if needed, instead of just dropping the requests like GitHub does.
|
||||
|
||||
Certain no-op events (which Discord would ignore anyway) and common CI bots are ignored by default; additional options can be configured per URL:
|
||||
|
||||
- Only forward events from specific branches (`allowBranches`, comma-separated list)
|
||||
- Ignore tag updates (`hideTags`)
|
||||
- Ignore burst PR review comments in a short timespan, only showing the first x comments (`commentBurstLimit`)
|
||||
Certain no-op events (which Discord would ignore anyway) and common CI bots are ignored by default; see [configuration](#configuration) below for more.
|
||||
|
||||
|
||||
## Usage
|
||||
|
@ -20,6 +16,15 @@ Certain no-op events (which Discord would ignore anyway) and common CI bots are
|
|||
1. Create a Discord webhook (`https://discord.com/api/webhooks/1234/ABCDWXYZ`).
|
||||
2. Take the ID (`1234`) and token (`ABCDWXYZ`) from the URL, and enter `https://<filter_url>/1234/ABCDWXYZ` (note: no `/github`) in the GitHub webhook settings:
|
||||
![settings](./.github/assets/github-settings.png)
|
||||
3. Optionally add configuration parameters (see above) to the URL, e.g. `?allowBranches=master,dev&hideTags=1`.
|
||||
3. Optionally add configuration parameters (see below) to the URL, e.g. `?allowBranches=master,dev&hideTags=1`.
|
||||
4. ????
|
||||
5. Profit!
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
Additional options can be configured per URL:
|
||||
|
||||
- Only forward events from specific branches (`allowBranches`, comma-separated list)
|
||||
- Ignore tag updates (`hideTags`)
|
||||
- Ignore burst PR review comments in a short timespan, only showing the first x comments (`commentBurstLimit`)
|
||||
|
|
Loading…
Reference in New Issue