section

Documentation

Index

• type Layout
  • func (l *Layout) AddSection(section *Section)
  • func (l *Layout) BucketOnEmojiMarkers()
  • func (l *Layout) BucketOnTextMarkers()
  • func (l *Layout) BucketToSection(commit *git.Commit)
  • func (l *Layout) GenerateDocumentation() string
  • func (l *Layout) SetDefaultSection(section *Section)
• type Section
  • func (s *Section) AddCommit(commit *git.Commit)
  • func (s *Section) AddEmojiShortcodes(emojis []string)
  • func (s *Section) AddTextMarkers(markers []string)
  • func (s *Section) Belongs(commitMessage string, matchEmoji bool) bool
  • func (s *Section) GenerateDocumentation() string

Types

type Layout

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

Layout for client to use

func (*Layout) AddSection

func (l *Layout) AddSection(section *Section)

AddSection adds new section

func (*Layout) BucketOnEmojiMarkers

func (l *Layout) BucketOnEmojiMarkers()

BucketOnEmojiMarkers buckets commits based on emojis

func (*Layout) BucketOnTextMarkers

func (l *Layout) BucketOnTextMarkers()

BucketOnTextMarkers buckets commits based on emojis

func (*Layout) BucketToSection

func (l *Layout) BucketToSection(commit *git.Commit)

BucketToSection buckets to appropriate section

func (*Layout) GenerateDocumentation

func (l *Layout) GenerateDocumentation() string

GenerateDocumentation generates documentation

func (*Layout) SetDefaultSection

func (l *Layout) SetDefaultSection(section *Section)

SetDefaultSection adds new section

type Section

type Section struct {
	Name            string
	EmojiShortcodes []string
	TextShortcodes  []string
	Commits         []*git.Commit
}

Section is a section in bulletin

func (*Section) AddCommit

func (s *Section) AddCommit(commit *git.Commit)

AddCommit adds commit to section

func (*Section) AddEmojiShortcodes

func (s *Section) AddEmojiShortcodes(emojis []string)

AddEmojiShortcodes adds new emojis to existing list

func (*Section) AddTextMarkers

func (s *Section) AddTextMarkers(markers []string)

AddTextMarkers adds new emojis to existing list

func (*Section) Belongs

func (s *Section) Belongs(commitMessage string, matchEmoji bool) bool

Belongs check if the commit message belongs to a section based on commit message

func (*Section) GenerateDocumentation

func (s *Section) GenerateDocumentation() string

GenerateDocumentation generates documentation