status-im
/
github-webhook-filter
mirror of https://github.com/status-im/github-webhook-filter.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

This commit is contained in:
shiftinv 2022-09-03 19:01:07 +02:00
parent 37cc5f16de
commit f214d4af1c
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,9 +1,10 @@
# github-webhook-filter
A webhook filter for [Deno](https://deno.land/), that filters github webhook events before
A webhook filter for [Deno](https://deno.land/) that filters github webhook events before
forwarding them to a Discord webhook, reducing noise.
Ignores common bots by default, additional options can be configured per URL:
Ignores common bots and no-op events by default, additional options can be configured per URL:
- Only forward events from specific branches
- Hide tag updates
- 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`)