changelog

Documentation

Index

• type Changelog
  • func FromCommits(sess *happy.Session, commits []Commit) (*Changelog, error)
  • func ParseGitLog(sess *happy.Session, log string) (*Changelog, error)
  • func (c *Changelog) Add(shortHash, longHash, author, subject string, typ EntryType)
  • func (c *Changelog) AddBreakingChange(shortHash, longHash, author, subject string)
  • func (c *Changelog) Breaking() []Entry
  • func (c *Changelog) Empty() bool
  • func (c *Changelog) Entries() []Entry
  • func (c *Changelog) HasMajorUpdate() bool
  • func (c *Changelog) HasMinorUpdate() bool
  • func (c *Changelog) HasPatchUpdate() bool
• type Commit
• type Entry
• type EntryKind
• type EntryType
  • func ParseEntryType(typ, scope string) (EntryType, error)

Types

type Changelog

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

func FromCommits

func FromCommits(sess *happy.Session, commits []Commit) (*Changelog, error)

func ParseGitLog

func ParseGitLog(sess *happy.Session, log string) (*Changelog, error)

func (*Changelog) Add

func (c *Changelog) Add(shortHash, longHash, author, subject string, typ EntryType)

func (*Changelog) AddBreakingChange

func (c *Changelog) AddBreakingChange(shortHash, longHash, author, subject string)

func (*Changelog) Breaking

func (c *Changelog) Breaking() []Entry

func (*Changelog) Empty

func (c *Changelog) Empty() bool

func (*Changelog) Entries

func (c *Changelog) Entries() []Entry

func (*Changelog) HasMajorUpdate

func (c *Changelog) HasMajorUpdate() bool

func (*Changelog) HasMinorUpdate

func (c *Changelog) HasMinorUpdate() bool

func (*Changelog) HasPatchUpdate

func (c *Changelog) HasPatchUpdate() bool

type Commit

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

type Entry

type Entry struct {
	ShortHash string
	LongHash  string
	Author    string
	Subject   string
	Typ       EntryType
}

type EntryKind

type EntryKind int

const (
	EntryKindPatch EntryKind = iota
	EntryKindMinor
	EntryKindMajor
)

type EntryType

type EntryType struct {
	Typ   string
	Scope string
	Kind  EntryKind
}

func ParseEntryType

func ParseEntryType(typ, scope string) (EntryType, error)