webhook

Documentation

Index

• Constants
• func NewCmdWebhook() *cobra.Command
• type Metrics
  • func NewMetrics() *Metrics
• type Options
  • func NewWebhook(factory jxfactory.Factory, server *Server) *Options
  • func (o *Options) GetBotName() string
  • func (o *Options) GetFactory() jxfactory.Factory
  • func (o *Options) ProcessWebHook(l *logrus.Entry, webhook scm.Webhook) (*logrus.Entry, string, error)
  • func (o *Options) Run() error
• type Server
  • func (s *Server) HandleBranchEvent(entry *logrus.Entry, hook *scm.BranchHook)
  • func (s *Server) HandleIssueCommentEvent(l *logrus.Entry, ic scm.IssueCommentHook)
  • func (s *Server) HandlePullRequestCommentEvent(l *logrus.Entry, pc scm.PullRequestCommentHook)
  • func (s *Server) HandlePullRequestEvent(l *logrus.Entry, pr *scm.PullRequestHook)
  • func (s *Server) HandlePushEvent(l *logrus.Entry, pe *scm.PushHook)
  • func (s *Server) HandleReviewEvent(l *logrus.Entry, re scm.ReviewHook)

Constants

const (
	// HealthPath is the URL path for the HTTP endpoint that returns health status.
	HealthPath = "/health"
	// ReadyPath URL path for the HTTP endpoint that returns ready status.
	ReadyPath = "/ready"
)

Functions

func NewCmdWebhook

func NewCmdWebhook() *cobra.Command

NewCmdWebhook creates the command

Types

type Metrics

type Metrics struct {
	WebhookCounter  *prometheus.CounterVec
	ResponseCounter *prometheus.CounterVec
}

Metrics is a set of metrics gathered by hook.

func NewMetrics

func NewMetrics() *Metrics

NewMetrics creates a new set of metrics for the hook server.

type Options

type Options struct {
	BindAddress string
	Path        string
	Port        int
	JSONLog     bool
	// contains filtered or unexported fields
}

Options holds the command line arguments

func NewWebhook

func NewWebhook(factory jxfactory.Factory, server *Server) *Options

NewWebhook creates a new webhook handler

func (*Options) GetBotName

func (o *Options) GetBotName() string

GetBotName returns the bot name

func (*Options) GetFactory

func (o *Options) GetFactory() jxfactory.Factory

GetFactory lazily creates a Factory if its not already created

func (*Options) ProcessWebHook

func (o *Options) ProcessWebHook(l *logrus.Entry, webhook scm.Webhook) (*logrus.Entry, string, error)

ProcessWebHook process a webhook

func (*Options) Run

func (o *Options) Run() error

Run will implement this command

type Server

type Server struct {
	ClientFactory  jxfactory.Factory
	ClientAgent    *plugins.ClientAgent
	Plugins        *plugins.ConfigAgent
	ConfigAgent    *config.Agent
	ServerURL      *url.URL
	TokenGenerator func() []byte
	Metrics        *Metrics
	// contains filtered or unexported fields
}

Server keeps the information required to start a server

func (*Server) HandleBranchEvent

func (s *Server) HandleBranchEvent(entry *logrus.Entry, hook *scm.BranchHook)

HandleBranchEvent handles a branch event

func (*Server) HandleIssueCommentEvent

func (s *Server) HandleIssueCommentEvent(l *logrus.Entry, ic scm.IssueCommentHook)

HandleIssueCommentEvent handle comment events

func (*Server) HandlePullRequestCommentEvent

func (s *Server) HandlePullRequestCommentEvent(l *logrus.Entry, pc scm.PullRequestCommentHook)

HandlePullRequestCommentEvent handles pull request comments events

func (*Server) HandlePullRequestEvent

func (s *Server) HandlePullRequestEvent(l *logrus.Entry, pr *scm.PullRequestHook)

HandlePullRequestEvent handles a pull request event

func (*Server) HandlePushEvent

func (s *Server) HandlePushEvent(l *logrus.Entry, pe *scm.PushHook)

HandlePushEvent handles a push event

func (*Server) HandleReviewEvent

func (s *Server) HandleReviewEvent(l *logrus.Entry, re scm.ReviewHook)

HandleReviewEvent handles a PR review event