github

Documentation

Index

• func WithPayloadSecret(secret string) option
• type Event
• type Provider
  • func New(eventChans []chan<- *Event, opts ...option) *Provider
  • func (p *Provider) HTTPHandler(resp http.ResponseWriter, req *http.Request)

Functions

func WithPayloadSecret

func WithPayloadSecret(secret string) option

Types

type Event

type Event struct {
	// DeliveryID is the unique github ID of the event
	DeliveryID string
	// Type is the github webhook event type returned by github.WebHookType()
	Type string
	// JSON is the event payload as JSON
	JSON []byte
	// Event is the parsed JSON payload as struct type returned by github.ParseWebHook()
	Event     any
	LogFields []zap.Field
}

Event is the preprocessed Github Webhook event

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider listens for github-webhook http-requests at a http-server handler. It validates, parses the webhook events and forwards them to event channels.

func New

func New(eventChans []chan<- *Event, opts ...option) *Provider

func (*Provider) HTTPHandler

func (p *Provider) HTTPHandler(resp http.ResponseWriter, req *http.Request)