webhook

type Event ¶

type Event struct {
	Kind     EventKind
	RepoURLs []string
	Branch   string
	Revision string
	PR       int
}

Event is a delivery reduced to what a deploy needs. RepoURLs lists every address the host gave for the repository, so it can be matched against the one the deployment was created from.

func (e *Event) MatchesRepo(ref string) bool

type EventKind ¶

type EventKind string

const (
	EventPush     EventKind = "push"
	EventPROpened EventKind = "pr_opened"
	EventPRSynced EventKind = "pr_synced"
	EventPRClosed EventKind = "pr_closed"
	// EventIgnored is a valid delivery the agent has nothing to do for, such
	// as a tag push, a branch deletion or a label change on a pull request.
	EventIgnored EventKind = "ignored"
)

type Generic ¶

type Generic struct{}

Generic is a deploy hook any CI system can call: X-FlatRun-Token carries the secret and an optional JSON body names the branch or revision to deploy.

func (Generic) Name() string

func (Generic) Parse(_ http.Header, body []byte) (*Event, error)

func (Generic) Verify(h http.Header, _ []byte, secret string) error

type GitHub ¶

type GitHub struct{}

GitHub verifies X-Hub-Signature-256 (HMAC-SHA256 of the body with the hook secret) and handles push and pull_request deliveries.

func (GitHub) Name() string

func (GitHub) Parse(h http.Header, body []byte) (*Event, error)

func (GitHub) Verify(h http.Header, body []byte, secret string) error

type GitLab ¶

type GitLab struct{}

GitLab compares X-Gitlab-Token with the hook secret and handles push and merge request deliveries.

func (GitLab) Name() string

func (GitLab) Parse(h http.Header, body []byte) (*Event, error)

func (GitLab) Verify(h http.Header, _ []byte, secret string) error

type Provider ¶

type Provider interface {
	Name() string
	Verify(h http.Header, body []byte, secret string) error
	Parse(h http.Header, body []byte) (*Event, error)
}

type Registry ¶

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

func DefaultRegistry() *Registry

func NewRegistry(providers ...Provider) *Registry

func (r *Registry) Get(name string) (Provider, bool)