github

Documentation

Index

• Constants
• Variables
• func MatchRegexp(reg, comment string) bool
• type AddChangedFiles
• type CheckType
• type InterceptorImpl
  • func NewInterceptor(sg interceptors.SecretGetter) *InterceptorImpl
  • func (w *InterceptorImpl) Process(ctx context.Context, r *triggersv1.InterceptorRequest) *triggersv1.InterceptorResponse
• type InterceptorParams
• type Owners
• type OwnersConfig
• type OwnersPayloadDetails

Constants

const (
	OKToTestCommentRegexp = `(^|\n)\/ok-to-test(\r\n|\r|\n|$)`
)

Variables

var ErrInvalidContentType = errors.New("form parameter encoding not supported, please change the hook to send JSON payloads")

ErrInvalidContentType is returned when the content-type is not a JSON body.

Functions

func MatchRegexp

func MatchRegexp(reg, comment string) bool

Types

type AddChangedFiles

type AddChangedFiles struct {
	Enabled             bool                  `json:"enabled,omitempty"`
	PersonalAccessToken *triggersv1.SecretRef `json:"personalAccessToken,omitempty"`
}

type CheckType

type CheckType string

const (
	// Set the checkType to orgMembers to allow org members to submit or comment on PR to proceed
	OrgMembers CheckType = "orgMembers"
	// Set the checkType to repoMembers to allow repo members to submit or comment on PR to proceed
	RepoMembers CheckType = "repoMembers"
	// Set the checkType to all if both repo members or org members can submit or comment on PR to proceed
	All CheckType = "all"
	// Set the checkType to none if neither of repo members or org members can not submit or comment on PR to proceed
	None CheckType = "none"
)

type InterceptorImpl

type InterceptorImpl struct {
	SecretGetter interceptors.SecretGetter
}

func NewInterceptor

func NewInterceptor(sg interceptors.SecretGetter) *InterceptorImpl

func (*InterceptorImpl) Process

func (w *InterceptorImpl) Process(ctx context.Context, r *triggersv1.InterceptorRequest) *triggersv1.InterceptorResponse

type InterceptorParams

type InterceptorParams struct {
	SecretRef *triggersv1.SecretRef `json:"secretRef,omitempty"`
	// +listType=atomic
	EventTypes      []string        `json:"eventTypes,omitempty"`
	AddChangedFiles AddChangedFiles `json:"addChangedFiles,omitempty"`
	GithubOwners    Owners          `json:"githubOwners,omitempty"`
}

InterceptorParams provides a webhook to intercept and pre-process events

type Owners

type Owners struct {
	Enabled bool `json:"enabled,omitempty"`
	// This param/variable is required for private repos or when checkType is set to orgMembers or repoMembers or all
	PersonalAccessToken *triggersv1.SecretRef `json:"personalAccessToken,omitempty"`
	// Set the value to one of the supported values (orgMembers, repoMembers, both, none)
	CheckType CheckType `json:"checkType,omitempty"`
}

type OwnersConfig

type OwnersConfig struct {
	Approvers []string `json:"approvers,omitempty"`
	Reviewers []string `json:"reviewers,omitempty"`
}

type OwnersPayloadDetails

type OwnersPayloadDetails struct {
	PrNumber         int
	Sender           string
	Owner            string
	Repository       string
	IssueCommentBody string
}