web

Documentation

Index

• func RequestLoggingMiddleware(h http.Handler) http.Handler
• type Push
• type WebAPI
  • func NewWebAPI(s *settings.Settings, r dinghyfile.DependencyManager, c util.PlankClient, ...) *WebAPI
  • func (wa *WebAPI) AddDinghyfileUnmarshaller(u dinghyfile.Unmarshaller)
  • func (wa *WebAPI) AddNotifier(n notifiers.Notifier)
  • func (wa *WebAPI) ProcessPush(p Push, b *dinghyfile.PipelineBuilder) error
  • func (wa *WebAPI) Router() *mux.Router
  • func (wa *WebAPI) SetDinghyfileParser(p dinghyfile.Parser)

Functions

func RequestLoggingMiddleware

func RequestLoggingMiddleware(h http.Handler) http.Handler

Types

type Push

type Push interface {
	ContainsFile(file string) bool
	Files() []string
	Repo() string
	Org() string
	Branch() string
	IsMaster() bool
	SetCommitStatus(s git.Status)
	Name() string
}

Push represents a push notification from a git service.

type WebAPI

type WebAPI struct {
	Config      *settings.Settings
	Client      util.PlankClient
	Cache       dinghyfile.DependencyManager
	EventClient *events.Client
	Logger      log.FieldLogger
	Ums         []dinghyfile.Unmarshaller
	Notifiers   []notifiers.Notifier
	Parser      dinghyfile.Parser
}

func NewWebAPI

func NewWebAPI(s *settings.Settings, r dinghyfile.DependencyManager, c util.PlankClient, e *events.Client, l log.FieldLogger) *WebAPI

func (*WebAPI) AddDinghyfileUnmarshaller

func (wa *WebAPI) AddDinghyfileUnmarshaller(u dinghyfile.Unmarshaller)

func (*WebAPI) AddNotifier

func (wa *WebAPI) AddNotifier(n notifiers.Notifier)

AddNotifier adds a Notifier type instance that will be triggered when a Dinghyfile processing phase completes (success/fail). It only gets triggered if there is work to do on a push (ie. a pipeline is intended to be updated)

func (*WebAPI) ProcessPush

func (wa *WebAPI) ProcessPush(p Push, b *dinghyfile.PipelineBuilder) error

ProcessPush processes a push using a pipeline builder

func (*WebAPI) Router

func (wa *WebAPI) Router() *mux.Router

Router defines the routes for the application.

func (*WebAPI) SetDinghyfileParser

func (wa *WebAPI) SetDinghyfileParser(p dinghyfile.Parser)