prcreation

Documentation

Index

• type PRCreationOptions
  • func (o *PRCreationOptions) AddFlags(fs *flag.FlagSet)
  • func (o *PRCreationOptions) Finalize() error
  • func (o *PRCreationOptions) UpsertPR(localSourceDir, org, repo, branch, prTitle string, setters ...PrOption) error
• type PrOption
  • func AdditionalLabels(additionalLabels []string) PrOption
  • func GitCommitMessage(gitCommitMessage string) PrOption
  • func MatchTitle(matchTitle string) PrOption
  • func PrAssignee(assignee string) PrOption
  • func PrBody(prBody string) PrOption
  • func SkipPRCreation() PrOption
• type PrOptions

Types

type PRCreationOptions

type PRCreationOptions struct {
	SelfApprove bool
	flagutil.GitHubOptions
	GithubClient github.Client
}

func (*PRCreationOptions) AddFlags

func (o *PRCreationOptions) AddFlags(fs *flag.FlagSet)

func (*PRCreationOptions) Finalize

func (o *PRCreationOptions) Finalize() error

func (*PRCreationOptions) UpsertPR

func (o *PRCreationOptions) UpsertPR(localSourceDir, org, repo, branch, prTitle string, setters ...PrOption) error

UpsertPR upserts a PR. The PRTitle must be alphanumeric except for spaces, as it will be used as the branchname on the bots fork.

type PrOption

type PrOption func(*PrOptions)

PrOption is the type for Optional Parameters

func AdditionalLabels

func AdditionalLabels(additionalLabels []string) PrOption

func GitCommitMessage

func GitCommitMessage(gitCommitMessage string) PrOption

GitCommitMessage is the wrapper to pass in PrCommitMessage that's different from the PrBody This is useful when you wish to provide large markdown information for the PR, but wish to keep the commit simple.

func MatchTitle

func MatchTitle(matchTitle string) PrOption

MatchTitle is the wrapper to pass in MatchTitle as a parameter

func PrAssignee

func PrAssignee(assignee string) PrOption

PrAssignee is the user to whom the PR is assigned

func PrBody

func PrBody(prBody string) PrOption

PrBody is the wrapper to pass in PrBody as a parameter

func SkipPRCreation

func SkipPRCreation() PrOption

SkipPRCreation skips the actual pr creation after committing and pushing

type PrOptions

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

PrOptions allows optional parameters to upsertPR