action

Documentation

Index

• func CheckAssignees(log *logrus.Logger, pull PullRequestAssignee) error
• func CheckBody(log *logrus.Logger, pull PullRequestBody, split string, minimum int) error
• func CheckLabels(log *logrus.Logger, pull PullRequestLabels, prefixes []string, mode string) error
• func CheckTitle(log *logrus.Logger, pull PullRequestTitle, minimum int) error
• func RunAutomations(logger *logrus.Logger, pull *github.PullRequest) error
• func RunChecks(logger *logrus.Logger, pull PullRequest, options *Options) error
• type Options
• type PullRequest
• type PullRequestAssignee
• type PullRequestBody
• type PullRequestLabels
• type PullRequestTitle

Functions

func CheckAssignees

func CheckAssignees(log *logrus.Logger, pull PullRequestAssignee) error

Check the title of the pull request to validate that it is at least the minimum length required, and return an error if it is not

func CheckBody

func CheckBody(log *logrus.Logger, pull PullRequestBody, split string, minimum int) error

Check the body of the pull request to validate that it is at least the minimum length required, and return an error if it is not

func CheckLabels

func CheckLabels(log *logrus.Logger, pull PullRequestLabels, prefixes []string, mode string) error

Check the labels of the pull request to validate that the prefixes requested have been attached, and return an error if it is not

func CheckTitle

func CheckTitle(log *logrus.Logger, pull PullRequestTitle, minimum int) error

Check the title of the pull request to validate that it is at least the minimum length required, and return an error if it is not

func RunAutomations

func RunAutomations(logger *logrus.Logger, pull *github.PullRequest) error

func RunChecks

func RunChecks(logger *logrus.Logger, pull PullRequest, options *Options) error

Types

type Options

type Options struct {
	TitleMinimum    int
	BodySplit       string
	BodyMinimum     int
	LabelPrefixes   string
	LabelPrefixMode string
	AutoAssign      bool
}

type PullRequest

type PullRequest interface {
	PullRequestTitle
	PullRequestLabels
	PullRequestBody
	PullRequestAssignee

	GetOwner() string
	GetRepository() string
	GetNumber() int
}

type PullRequestAssignee

type PullRequestAssignee interface {
	GetUser() *github.User
	GetAssignees() []*github.User
	SetAssignee([]string) error
}

Define an Interface which maps to the GetAssignee function on the type so that we can simplify the requirements of the value passed and improve testability

type PullRequestBody

type PullRequestBody interface {
	GetBody() string
}

Define an Interface which maps to the GetBody function on the type so that we can simplify the requirements of the value passed and improve testability

type PullRequestLabels

type PullRequestLabels interface {
	GetLabels() []*github.Label
}

Define an Interface which maps to the GetLabels function on the type so that we can simplify the requirements of the value passed and improve testability

type PullRequestTitle

type PullRequestTitle interface {
	GetTitle() string
}

Define an Interface which maps to the GetTitle function on the type so that we can simplify the requirements of the value passed and improve testability