Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mini-bomba/github-webhook-proxy
A WebWorker that proxies webhook payloads between GitHub and Discord, adding extra data for some events.
https://github.com/mini-bomba/github-webhook-proxy
discord github webhook
Last synced: about 1 month ago
JSON representation
A WebWorker that proxies webhook payloads between GitHub and Discord, adding extra data for some events.
- Host: GitHub
- URL: https://github.com/mini-bomba/github-webhook-proxy
- Owner: mini-bomba
- License: mit
- Created: 2022-07-12T21:15:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T22:20:20.000Z (about 2 months ago)
- Last Synced: 2024-11-15T22:21:50.557Z (about 2 months ago)
- Topics: discord, github, webhook
- Language: TypeScript
- Homepage: https://github-webhook-proxy.minibomba.workers.dev
- Size: 34.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-webhook-proxy
A WebWorker that proxies webhook payloads between GitHub and Discord,
adding extra data for some events.
Public instance available at https://github-webhook-proxy.minibomba.workers.dev
## Routes
```
POST /{channel ID}/{webhook token} - Execute webhook
POST /{channel ID}/{webhook token}?color={color}
channel ID and webhook token should be taken from a discord webhook URL
color specifies embed color for the release created event
/ - Redirects to this repository
/version - Sends currently deployed git hash
/source - Redirects to a view of the currently deployed commit
```
## How to use
Grab a discord webhook URL and replace `https://discord.com/api/webhooks` with `https://github-webhook-proxy.minibomba.workers.dev` (or your own instance URL)
## Why
Discord's GitHub webhook support isn't great. It doesn't attach release descriptions to messages about them being created, it can't differentiate between a PR getting closed and it getting merged, it doesn't know about the different issue close reasons.
This project was created to mitiage some of these issues.
It currently intercepts and improves the following events:
- release creation
- adds the release description and timestamp into the message
- issue closing/reopening
- includes the reason for closing the issue (completed/not planned)
- adds colors associated with the different close reasons and reopening the issue
- pull requests
- differentiates between closing and merging the PR
- sends messages when a PR is marked as draft or ready for review
- adds colors associated with these actions
- blocks "Pull request review submitted" events when someone comments on a review
- review comment content will still be sent to discord if pull_request_review_comment event is enabled. this simply removes the noise
## some images i guess
### issue events
### PR and release events
