options

Documentation

Index

• Constants
• type Options
  • func New() *Options
  • func (o *Options) Client() client.Client
  • func (o *Options) ValidateAndFinish() (err error)
• type RevisionDiscoveryMode

Constants

const (
	RevisionDiscoveryModeNONE              = "none"
	RevisionDiscoveryModeMergeBaseToLatest = "mergebase-to-latest"
	RevisionDiscoveryModePatchToPatch      = "patch-to-patch"
	RevisionDiscoveryModeMinorToMinor      = "minor-to-minor"
)

Types

type Options

type Options struct {
	GithubOrg       string
	GithubRepo      string
	Output          string
	Branch          string
	StartSHA        string
	EndSHA          string
	StartRev        string
	EndRev          string
	RepoPath        string
	ReleaseVersion  string
	Format          string
	RequiredAuthor  string
	DiscoverMode    string
	ReleaseBucket   string
	ReleaseTars     string
	TableOfContents bool
	Debug           bool
	Pull            bool
	RecordDir       string
	ReplayDir       string
	// contains filtered or unexported fields
}

func New

func New() *Options

New creates a new Options instance with the default values

func (*Options) Client

func (o *Options) Client() client.Client

Client returns a Client to be used by the Gatherer. Depending on the provided options this is either a real client talking to the GitHub API, a Client which in addition records the responses from Github and stores them on disk, or a Client that replays those pre-recorded responses and does not talk to the GitHub API at all.

func (*Options) ValidateAndFinish

func (o *Options) ValidateAndFinish() (err error)

ValidateAndFinish checks if the options are set in a consistent way and adapts them if necessary. It returns an error if options are set to invalid values.

type RevisionDiscoveryMode

type RevisionDiscoveryMode string