git-webhooks/README.md

13 lines
798 B
Markdown
Raw Normal View History

2024-08-01 18:19:05 +10:00
# 🪝 git-webhooks
2024-08-01 15:20:34 +10:00
2024-08-01 18:19:05 +10:00
This Express app listens for webhook events from a git hosting service. It was originally written for GitHub but also works with Gitea and Forgejo, and anything else that uses the `X-Hub-Signature-256` header to send an HMAC SHA-256 digest of the payload. Alternatively you could change the code to look for a different header.
How this works is outlined in a blog post - [Automation workflows with GitHub Actions and Webhooks](https://www.hughrundle.net/automation-workflows-with-github-actions-and-webhooks/), though I have slightly updated the code since then.
## Installation
See [the instructions](/docs.md) for installing on a server.
## Testing
There isn't a test suite, but you can use the `curl_test.sh` script to manually test that your app is working correctly.