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:
wyf9
parent
68cda9f178
commit
afe19795b1
25 changed files with 621 additions and 398 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Supported Events
|
||||
|
||||
WebHooker supports 23 GitHub webhook event types, each with a dedicated formatter that produces rich Discord embeds. Unsupported events fall through to a generic formatter.
|
||||
WebHooker supports 28 GitHub webhook event types, each with a dedicated formatter that produces rich Discord embeds and Telegram HTML messages. Unsupported events fall through to a generic formatter.
|
||||
|
||||
## Events Table
|
||||
|
||||
|
|
@ -11,16 +11,21 @@ WebHooker supports 23 GitHub webhook event types, each with a dedicated formatte
|
|||
| `issues` | Issue opened/closed/edited | Issue title, labels, assignees |
|
||||
| `issue_comment` | Comment on issue or PR | Comment body, issue reference |
|
||||
| `workflow_run` | CI/CD workflow phase updated | Workflow status, conclusion, duration; phases update a single message in place |
|
||||
| `workflow_job` | CI job phase updated | Job name, status, conclusion, workflow |
|
||||
| `status` | Commit status updated | Commit status, context, state, commit link |
|
||||
| `deployment` | Deployment created | Environment, ref, task |
|
||||
| `deployment_status` | Deployment status updated | Environment, status, commit ref |
|
||||
| `check_run` | Check run completed | Status, conclusion, details URL |
|
||||
| `check_suite` | Check suite completed | Suite conclusion, head branch, commit link |
|
||||
| `ping` | Webhook confirmation | Webhook confirmation, event types subscribed |
|
||||
| `release` | Release published/edited | Tag, body, assets, pre-release flag |
|
||||
| `create` | Branch or tag created | Ref name, ref type |
|
||||
| `delete` | Branch or tag deleted | Ref name, ref type |
|
||||
| `star` | Repository starred/unstarred | Star count, action |
|
||||
| `fork` | Repository forked | Source → target fork |
|
||||
| `check_run` | Check run completed | Status, conclusion, details URL |
|
||||
| `pull_request_review` | PR review submitted | Review state (approved/changes/commented), body |
|
||||
| `pull_request_review_comment` | Inline code review comment | File path, line number, comment body |
|
||||
| `commit_comment` | Comment on a commit | Commit SHA, comment body |
|
||||
| `deployment_status` | Deployment status updated | Environment, status, commit ref |
|
||||
| `member` | Collaborator added/removed | Member login, action |
|
||||
| `label` | Label created/edited/deleted | Label name, color, description |
|
||||
| `milestone` | Milestone opened/closed | Progress bar, issue counts, due date |
|
||||
|
|
@ -32,18 +37,17 @@ WebHooker supports 23 GitHub webhook event types, each with a dedicated formatte
|
|||
|
||||
## Color Coding
|
||||
|
||||
Each event type uses a distinct color in the Discord embed:
|
||||
Each event type uses a distinct color in the Discord embed (from `src/formatters/colors.ts`):
|
||||
|
||||
| Color | Events |
|
||||
| ------------------ | -------------------------------------------------------------------- |
|
||||
| Green (`#2ea44f`) | push, issue opened, PR opened, release published, star, member added |
|
||||
| Red (`#d73a49`) | issue closed, PR closed, deployment failure, dependabot critical |
|
||||
| Purple (`#7057ff`) | PR merged, discussion created |
|
||||
| Blue (`#0366d6`) | PR review commented, issue comment, workflow run |
|
||||
| Yellow (`#dbab09`) | PR review changes requested, deployment pending |
|
||||
| Teal (`#00897b`) | check run, code scanning |
|
||||
| Orange (`#e67e22`) | label, milestone |
|
||||
| Gray (`#6a737d`) | delete, repository, member removed |
|
||||
| Color | Events |
|
||||
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Green (`#2da44e`) | push, PR opened / ready for review, issue opened, workflow success, release published, check success, review approved, deployment success, member added, milestone closed, discussion answered |
|
||||
| Red (`#f85149`) | PR closed, issue closed, workflow failure, release deleted, delete, check failure, review changes requested, deployment failure, member removed, code scanning / dependabot critical & high |
|
||||
| Purple (`#8957e5`) | PR merged, label, discussion |
|
||||
| Blue (`#1f6feb`) | PR (other actions), issue reopened, fork, milestone opened |
|
||||
| Yellow (`#d29922`) | workflow (queued/running/other), release prerelease, star, check (other), deployment pending, code scanning / dependabot medium |
|
||||
| Gray (`#6e7681`) | issue comment, commit comment, discussion comment |
|
||||
| Gray (`#8b949e`) | review commented, repository, code scanning / dependabot low, default |
|
||||
|
||||
## Generic Fallback
|
||||
|
||||
|
|
@ -63,11 +67,11 @@ Any event type without a dedicated formatter falls through to the generic format
|
|||
|
||||
See the [Filter Tutorial](../guide/filters) for a hands-on guide with worked examples.
|
||||
|
||||
| Filter | Works With |
|
||||
| --------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `event` | All events |
|
||||
| `repo` | All events |
|
||||
| `actor` | All events |
|
||||
| `action` | Events with `action` field in payload |
|
||||
| `branch` | push, pull_request, pull_request_review, pull_request_review_comment, create, delete, workflow_run, code_scanning_alert |
|
||||
| `keyword` | All events (searches full payload body) |
|
||||
| Filter | Works With |
|
||||
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `event` | All events |
|
||||
| `repo` | All events |
|
||||
| `actor` | All events |
|
||||
| `action` | Events with `action` field in payload |
|
||||
| `branch` | push, pull_request, pull_request_review, pull_request_review_comment, create, delete, workflow_run, workflow_job, check_suite, deployment, code_scanning_alert |
|
||||
| `keyword` | All events (searches full payload body) |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue