forge
/
archive_hook.sh
Archived
1
0
Fork 0
Code Issues 4 Pull Requests Releases Wiki Activity

Add project status in README

This commit is contained in:
southerntofu 2020-04-28 11:45:00 +02:00
parent ac75b0536a
commit 75a15dec05
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,6 +6,10 @@ These scripts are not intended to be used for generic webhooks, but for those pr
**Note**: Some specific parts of forgehook do not yet correspond to what you will find here. That's because I'm taking some time to step back and think about what's implemented so far and how it should end up, before i deepdive into the code again. The inconsistencies are marked with TODO notes.
# Current status
As of April 28, the reference implementation for `forgehook-db` (databases/unix) works fine, so does `forgehook-notify` and the default `forgehook-trigger` (triggers/git-build). No endpoint is implemented yet.
# Introduction to webhooks
Webhooks are simple web pings performed by a client to inform a server that something happened (push model). In the context of a [forge](https://en.wikipedia.org/wiki/Forge_(software)) (such as Gitea), a webhook additionally contains information as JSON payload about what changed on the repository, as well as an [HTTP signature](https://datatracker.ietf.org/doc/draft-ietf-httpbis-message-signatures/) in order to authenticate the client who sent the webhook via a shared secret.