git

Documentation

Index

• type CommitDetail
  • func (c CommitDetail) String() string
• type Git
  • func NewClient(URL, token, issuePattern string, opts ...GitOpt) (Git, error)
  • func (g Git) ExtractCommits(id, from, to string) ([]CommitDetail, error)
• type GitOpt
  • func WithCustomPattern(v string) GitOpt
  • func WithKeepCCWithoutScope(v bool) GitOpt

Types

type CommitDetail

type CommitDetail struct {
	Category     parsers.CCType           `yaml:"category,omitempty"`
	IssueKey     string                   `yaml:"issueKey,omitempty"`
	IsBreaking   bool                     `yaml:"isBreakingChange,omitempty"`
	Summary      string                   `yaml:"summary,omitempty"`
	Message      string                   `yaml:"message,omitempty"`
	Commit       string                   `yaml:"commit,omitempty"`
	IssueTracker parsers.IssueTrackerType `yaml:"issueTrackerType"`
}

func (CommitDetail) String

func (c CommitDetail) String() string

type Git

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

func NewClient

func NewClient(URL, token, issuePattern string, opts ...GitOpt) (Git, error)

func (Git) ExtractCommits

func (g Git) ExtractCommits(id, from, to string) ([]CommitDetail, error)

type GitOpt

type GitOpt func(*Git)

func WithCustomPattern

func WithCustomPattern(v string) GitOpt

func WithKeepCCWithoutScope

func WithKeepCCWithoutScope(v bool) GitOpt