framework

Documentation

Overview

Package framework exposes helpers for robot pre handling of http request

Package framework exposes helpers for robot event handling template interface

Package framework exposes helpers for robot logger

Package framework exposes helpers for robot http server

Index

• Constants
• func NewLogger() *logrus.Entry
• func NewServer(bot Robot, opt config.FrameworkOptions) *http.Server
• func SetRobotUserID(userID string)
• func StartupServer(httpServer *http.Server, opt config.FrameworkOptions)
• type GenericHandlerFunc
• type HandlerRegister
• type Robot

Constants

const (
	PushEvent        = "Push Hook"
	IssueEvent       = "Issue Hook"
	PullRequestEvent = "Merge Request Hook"
	NoteEvent        = "Note Hook"
)

Functions

func NewLogger

func NewLogger() *logrus.Entry

func NewServer

func NewServer(bot Robot, opt config.FrameworkOptions) *http.Server

func SetRobotUserID

func SetRobotUserID(userID string)

func StartupServer

func StartupServer(httpServer *http.Server, opt config.FrameworkOptions)

Types

type GenericHandlerFunc

type GenericHandlerFunc func(evt *client.GenericEvent, cnf config.Configmap, logger *logrus.Entry)

type HandlerRegister

type HandlerRegister interface {
	RegisterIssueHandler(GenericHandlerFunc)
	RegisterIssueCommentHandler(GenericHandlerFunc)
	RegisterPullRequestHandler(GenericHandlerFunc)
	RegisterPullRequestCommentHandler(GenericHandlerFunc)
	RegisterPushEventHandler(GenericHandlerFunc)
}

type Robot

type Robot interface {
	GetConfigmap() config.Configmap
	RegisterEventHandler(HandlerRegister)
	GetLogger() *logrus.Entry
}