config

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func EmptyConfig() *Config
  • func (c Config) MergeMethod() (genclient.PullRequestMergeMethod, error)
  • func (c *Config) Normalize()
• type InternalState
• type RepoConfig
• type UserConfig

Types

type Config

type Config struct {
	Repo  *RepoConfig
	User  *UserConfig
	State *InternalState
}

func DefaultConfig

func DefaultConfig() *Config

func EmptyConfig

func EmptyConfig() *Config

func (Config) MergeMethod

func (c Config) MergeMethod() (genclient.PullRequestMergeMethod, error)

func (*Config) Normalize

func (c *Config) Normalize()

Normalize applies normalization rules to the config For example, if PRTemplatePath is provided, PRTemplateType should be set to "custom"

type InternalState

type InternalState struct {
	MergeCheckCommit map[string]string `yaml:"mergeCheckCommit"`

	Stargazer bool `default:"false" yaml:"stargazer"`
	RunCount  int  `default:"0" yaml:"runcount"`
}

type RepoConfig

type RepoConfig struct {
	GitHubRepoOwner string `yaml:"githubRepoOwner"`
	GitHubRepoName  string `yaml:"githubRepoName"`
	GitHubHost      string `default:"github.com" yaml:"githubHost"`

	GitHubRemote string `default:"origin" yaml:"githubRemote"`
	GitHubBranch string `default:"main" yaml:"githubBranch"`

	RequireChecks    bool     `default:"true" yaml:"requireChecks"`
	RequireApproval  bool     `default:"true" yaml:"requireApproval"`
	DefaultReviewers []string `yaml:"defaultReviewers"`

	MergeMethod string `default:"rebase" yaml:"mergeMethod"`
	MergeQueue  bool   `default:"false" yaml:"mergeQueue"`

	PRTemplateType        string `default:"stack" yaml:"prTemplateType"`
	PRTemplatePath        string `yaml:"prTemplatePath,omitempty"`
	PRTemplateInsertStart string `yaml:"prTemplateInsertStart,omitempty"`
	PRTemplateInsertEnd   string `yaml:"prTemplateInsertEnd,omitempty"`

	MergeCheck string `yaml:"mergeCheck,omitempty"`

	ForceFetchTags bool `default:"false" yaml:"forceFetchTags"`

	ShowPrTitlesInStack    bool `default:"false" yaml:"showPrTitlesInStack"`
	BranchPushIndividually bool `default:"false" yaml:"branchPushIndividually"`
}

Config object to hold spr configuration

type UserConfig

type UserConfig struct {
	ShowPRLink       bool `default:"true" yaml:"showPRLink"`
	LogGitCommands   bool `default:"true" yaml:"logGitCommands"`
	LogGitHubCalls   bool `default:"true" yaml:"logGitHubCalls"`
	StatusBitsHeader bool `default:"true" yaml:"statusBitsHeader"`
	StatusBitsEmojis bool `default:"true" yaml:"statusBitsEmojis"`

	CreateDraftPRs       bool `default:"false" yaml:"createDraftPRs"`
	PreserveTitleAndBody bool `default:"false" yaml:"preserveTitleAndBody"`
	NoRebase             bool `default:"false" yaml:"noRebase"`
	DeleteMergedBranches bool `default:"false" yaml:"deleteMergedBranches"`
}