mirror of
https://github.com/ReCloudStudio/WebHooker.git
synced 2026-09-22 16:11:29 +00:00
docs: sync documentation with current codebase
- Update event formatter count 23 -> 28 (add ping, workflow_job, status, deployment, check_suite) - Document Telegram support end-to-end (routes, /gh commands, richheader, secrets) - Fix route schema to use targets array and group fields (owners, emoji) - Correct KV/D1 storage layout (msg:*, i18n:*, D1 links/send_logs) - Note GITHUB_APP_ID/GITHUB_PRIVATE_KEY are unused; drop legacy DISCORD_CHANNEL_ID/PORT/CONFIG_PATH - Remove stale Docker deployment section - Update color table, branch filter compatibility, admin API endpoints - AGENTS.md: add Documentation section requiring doc updates after functional changes
This commit is contained in:
parent
68cda9f178
commit
afe19795b1
25 changed files with 621 additions and 398 deletions
|
|
@ -1,34 +1,63 @@
|
|||
# Routes
|
||||
# Each route defines a filter chain and target Discord channel
|
||||
# Each route defines a filter chain and one or more target destinations
|
||||
# (Discord channel/thread and/or Telegram chat/topic). See docs/guide/configuration.md.
|
||||
|
||||
# Groups scope admin access and can restrict which org/user events flow in.
|
||||
groups:
|
||||
- id: default
|
||||
name: "Default"
|
||||
adminIds: ["your-github-id"]
|
||||
# owners: ["myorg"] # restrict events to this org/user (optional)
|
||||
# emoji: true # include emoji in messages (default true)
|
||||
|
||||
routes:
|
||||
- id: all-push
|
||||
name: "All Push Events"
|
||||
enabled: true
|
||||
groupId: default
|
||||
filters:
|
||||
- type: event
|
||||
match: push
|
||||
target:
|
||||
channelId: "CHANNEL_ID_HERE"
|
||||
targets:
|
||||
- platform: discord
|
||||
channelId: "CHANNEL_ID_HERE"
|
||||
|
||||
# - id: specific-repo
|
||||
# name: "Specific Repo"
|
||||
# enabled: true
|
||||
# groupId: default
|
||||
# filters:
|
||||
# - type: repo
|
||||
# match: "org/repo"
|
||||
# - type: event
|
||||
# match: [pull_request, issues]
|
||||
# target:
|
||||
# channelId: "CHANNEL_ID_HERE"
|
||||
# threadId: "THREAD_ID_HERE"
|
||||
# targets:
|
||||
# - platform: discord
|
||||
# channelId: "CHANNEL_ID_HERE"
|
||||
# threadId: "THREAD_ID_HERE"
|
||||
# - platform: telegram
|
||||
# chatId: "-1001234567890"
|
||||
# topicId: "9876543210"
|
||||
|
||||
# - id: exclude-bot
|
||||
# name: "Exclude Bot Actions"
|
||||
# enabled: true
|
||||
# groupId: default
|
||||
# filters:
|
||||
# - type: actor
|
||||
# match: "[bot]"
|
||||
# exclude: true
|
||||
# target:
|
||||
# channelId: "CHANNEL_ID_HERE"
|
||||
# targets:
|
||||
# - platform: discord
|
||||
# channelId: "CHANNEL_ID_HERE"
|
||||
|
||||
# Fallback routes only fire when no other (non-fallback) route matched.
|
||||
# - id: fallback-all
|
||||
# name: "Fallback: everything else"
|
||||
# enabled: true
|
||||
# groupId: default
|
||||
# fallback: true
|
||||
# filters: []
|
||||
# targets:
|
||||
# - platform: telegram
|
||||
# chatId: "-1001234567890"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue