gh

Documentation

Index

• Variables
• type Parser
  • func (p *Parser) GetName() string
  • func (p *Parser) Parse(headers map[string][]string, payload []byte) (provider.Event, error)
• type Validator
  • func NewValidator(secret string) *Validator
  • func (g *Validator) IsSupported(incomingProvider string) bool
  • func (g *Validator) Validate(r *http.Request) error

Variables

var (
	// ErrorUnknownType is used when the given type is not supported.
	ErrorUnknownType = errors.New("unknown event type")

	// ErrorNoHeadCommit is used when the the event has no head commit.
	ErrorNoHeadCommit = errors.New("no head commit provided in the event")
)

Types

type Parser

type Parser struct{}

Parser is the GitHub webhook parser.

func (*Parser) GetName

func (p *Parser) GetName() string

GetName returns the parser name.

func (*Parser) Parse

func (p *Parser) Parse(headers map[string][]string, payload []byte) (provider.Event, error)

Parse parses the incoming webhook. nolint: exhaustivestruct, funlen

type Validator

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

func NewValidator

func NewValidator(secret string) *Validator

func (*Validator) IsSupported

func (g *Validator) IsSupported(incomingProvider string) bool

func (*Validator) Validate

func (g *Validator) Validate(r *http.Request) error