spr

Documentation

Index

• func AmendCommit(ctx context.Context)
• func NewStackedPR(config *Config, debug bool) *stackediff
• type Config
  • func ReadConfig() *Config

Functions

func AmendCommit

func AmendCommit(ctx context.Context)

AmendCommit enables one to easily ammend a commit in the middle of a stack

of commits. A list of commits is printed and one can be chosen to be ammended.

func NewStackedPR

func NewStackedPR(config *Config, debug bool) *stackediff

NewStackedPR constructs and returns a new instance stackediff.

Types

type Config

type Config struct {
	GitHubRepoOwner string `yaml:"githubRepoOwner"`
	GitHubRepoName  string `yaml:"githubRepoName"`

	RequireChecks   bool `yaml:"requireChecks"`
	RequireApproval bool `yaml:"requireApproval"`
}

Config object to hold spr configuration

func ReadConfig

func ReadConfig() *Config

ReadConfig looks for a .spr.yml file in the root git directory.

if found, the config is read and returned.
if not found, a default config is created written to the config file and
 returned.