config

Documentation

Index

• func GitHubRemoteSource(config *Config, gitcmd git.GitInterface) *remoteSource
• func RepoConfigFilePath(gitcmd git.GitInterface) string
• func UserConfigFilePath() string
• type Config
  • func DefaultConfig() *Config
  • func EmptyConfig() *Config
  • func ParseConfig(gitcmd git.GitInterface) *Config
  • func (c Config) MergeMethod() (githubv4.PullRequestMergeMethod, error)
• type RepoConfig
• type UserConfig

Functions

func GitHubRemoteSource

func GitHubRemoteSource(config *Config, gitcmd git.GitInterface) *remoteSource

func RepoConfigFilePath

func RepoConfigFilePath(gitcmd git.GitInterface) string

func UserConfigFilePath

func UserConfigFilePath() string

Types

type Config

type Config struct {
	Repo *RepoConfig
	User *UserConfig
}

func DefaultConfig

func DefaultConfig() *Config

func EmptyConfig

func EmptyConfig() *Config

func ParseConfig

func ParseConfig(gitcmd git.GitInterface) *Config

func (Config) MergeMethod

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

type RepoConfig

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

	RequireChecks   bool `default:"true" yaml:"requireChecks"`
	RequireApproval bool `default:"true" yaml:"requireApproval"`

	GitHubRemote string `default:"origin" yaml:"githubRemote"`
	GitHubBranch string `default:"master" yaml:"githubBranch"`
	MergeMethod  string `default:"rebase" yaml:"mergeMethod"`
}

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"`

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