docs: document github webhooks

This commit is contained in:
Jörg Thalheim 2021-10-30 09:35:01 +02:00
parent 70f1db2762
commit 1593e0212e
2 changed files with 14 additions and 0 deletions

View file

@ -8,6 +8,7 @@
- [Plugins](./plugins/README.md)
- [Declarative Projects](./plugins/declarative-projects.md)
- [Using the external API](api.md)
- [Webhooks](webhooks.md)
- [Monitoring Hydra](./monitoring/README.md)
## Developer's Guide

View file

@ -0,0 +1,13 @@
# Webhooks
Hydra can be notified by github's webhook to trigger a new evaluation when a
jobset has a github repo in its input.
To set up a github webhook go to `https://github.com/<yourhandle>/<yourrepo>/settings` and in the `Webhooks` tab
click on `Add webhook`.
- In `Payload URL` fill in `https://<your-hydra-domain>/api/push-github`.
- In `Content type` switch to `application/json`.
- The `Secret` field can stay empty.
- For `Which events would you like to trigger this webhook?` keep the default option for events on `Just the push event.`.
Then add the hook with `Add webhook`.