ReCloudStudio/WebHooker
1
0
Fork 0
mirror of https://github.com/ReCloudStudio/WebHooker.git synced 2026-09-22 16:11:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: sync documentation with current codebase

Browse source 
- 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:
wyf9 2026-08-05 17:22:15 +08:00
parent 68cda9f178
commit afe19795b1
No known key found for this signature in database
GPG key ID: B126966081BFDBE4
25 changed files with 621 additions and 398 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/index.md
View file

@ -4,7 +4,7 @@ layout: home
hero:
name: WebHooker
text: GitHub Webhook → Discord
tagline: Receive GitHub events via Cloudflare Workers, apply filters, and route formatted messages to Discord channels or threads.
tagline: Receive GitHub events via Cloudflare Workers, apply filters, and route formatted messages to Discord channels/threads and Telegram chats/topics.
actions:
- theme: brand
text: Get Started
@ -14,16 +14,16 @@ hero:
link: https://github.com/ReCloudStudio/WebHooker
features:
- title: 23 Event Formatters
details: Rich Discord embeds for push, pull_request, issues, release, workflow_run, and 18 more event types with color-coded output.
- title: 28 Event Formatters
details: Rich Discord embeds and Telegram HTML for push, pull_request, issues, release, workflow_run, and 23 more event types with color-coded output.
- title: Flexible Filtering
details: Filter by event type, repo, actor, action, branch (including PRs), and keyword (with regex support). Exclude patterns with a flag.
- title: Cloudflare Workers
details: Runs on Cloudflare's edge network. Sends via the Discord REST API, with an Ed25519-verified Interactions Endpoint for `/gh` slash commands and buttons.
- title: Web UI & Slash Commands
details: "Manage routes and view send logs from a built-in admin console. Link your GitHub account and comment on issues/PRs as yourself via /gh commands."
details: Runs on Cloudflare's edge network. Sends via the Discord REST API and Telegram Bot API, with an Ed25519-verified Interactions Endpoint for `/gh` slash commands and buttons.
- title: Web UI, Groups & Commands
details: "Manage routes, groups and send logs from a built-in admin console. Link your GitHub account and comment on issues/PRs as yourself via /gh commands on Discord or Telegram."
- title: Signature Verification
details: HMAC-SHA256 webhook signature verification and Ed25519 interaction signature verification using the Web Crypto API with timing-safe comparison.
- title: Graceful Degradation
details: Runs in webhook-only mode if Discord token is unavailable. Health endpoint for monitoring.
- title: In-Place Updates
details: workflow_run progress is edited in place on a single message as the run advances, on both Discord and Telegram.
---