Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
Signed-off-by: Jalander Ramagiri <[email protected]>
  • Loading branch information
Jalander Ramagiri committed Aug 26, 2024
1 parent 2f7675e commit 22c3c4f
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,18 @@
A CDEvents Webhook Adapter can receive events via Webhooks and translate them into CDEvents,
with the help of various translators which supports publishing events via Webhooks.

This adapter provides client and server implementation over an RPC connection and exposes an interface for plugin implementation,
Various translators can be developed as plugins using Hashicorp's [go-plugin](https://github.com/hashicorp/go-plugin/)
This adapter provides client and server implementation over an RPC connection and exposes an interface for plugin implementation,
````go
// EventTranslator is the interface that we're exposing as a plugin.
type EventTranslator interface {
TranslateEvent(event string, headers http.Header) (string, error)
}

````
Various translators can be developed as plugins by implementing this interface method and serve using Hashicorp's [go-plugin](https://github.com/hashicorp/go-plugin/?tab=readme-ov-file#usage)

## Plugins implemented using this adapter
| Plugin Name | Plugin URL |
| :------------ |:-------------------|
| gerrit-translator-cdevents| https://github.com/cdevents/gerrit-translator |
| jira-translator-cdevents | https://github.com/cdevents/jira-translator |

0 comments on commit 22c3c4f

Please sign in to comment.