change

Documentation

Index

• Constants
• Variables
• func DefaultAuthor() string
• func Slug(title string) string
• func TargetUiApi() int
• type Entries
  • func (e Entries) Authors() []string
  • func (e Entries) Filter(filter func(*Entry) bool) Entries
  • func (e Entries) FilterByComponent(component string) Entries
  • func (e Entries) FilterByReason(reason Reason) Entries
  • func (e Entries) GroupByComponent() map[string]Entries
  • func (e Entries) GroupByReason() map[Reason]Entries
  • func (e Entries) SortByAuthor() Entries
  • func (e Entries) SortByComponent() Entries
  • func (e Entries) SortByMergeRequest() Entries
  • func (e Entries) SortByReason() Entries
  • func (e Entries) SortByTitle() Entries
• type Entry
  • func NewEntry() *Entry
  • func (e *Entry) IsAnonymous() bool
  • func (e *Entry) IsZero() bool
  • func (e *Entry) MergeRequestString() string
  • func (e *Entry) Slug() string
  • func (e *Entry) String() string
• type EntryPrompt
  • func NewEntryPrompt(targetUiApi int) *EntryPrompt
  • func (p *EntryPrompt) Run(entry *Entry) (bool, error)
• type EntrySerializer
  • func NewEntrySerializer() *EntrySerializer
  • func (s *EntrySerializer) Deserialize(data []byte) (interface{}, error)
  • func (s *EntrySerializer) Serialize(entry interface{}) ([]byte, error)
• type Reason
  • func ParseReason(value string) (Reason, error)
  • func (r Reason) Alias() string
  • func (r Reason) CapsString() string
  • func (r Reason) Description() string
  • func (r Reason) IsZero() bool
  • func (r Reason) MarshalYAML() (interface{}, error)
  • func (r Reason) String() string
  • func (r Reason) TitleString() string
  • func (r *Reason) UnmarshalJSON(value []byte) error
  • func (r *Reason) UnmarshalText(value []byte) error
  • func (r *Reason) UnmarshalYAML(value *yaml.Node) error
• type Writer
  • func NewWriter(output io.EntityWriter) *Writer
  • func (w *Writer) Write(e *Entry) (string, error)
  • func (w *Writer) WriteFile(e *Entry, filename string) (string, error)

Constants

const (
	DefaultUnreleasedDir = "changelogs/unreleased"
	FilenameExtension    = ".yml"
)

const UiApi = 1

Variables

var (
	ReasonNames = []string{
		"",
		"added",
		"fixed",
		"changed",
		"deprecated",
		"removed",
		"security",
		"performance",
		"other",
	}
	ReasonDescriptions = []string{
		"",
		"New Features",
		"Fixed Issues",
		"Changed Features",
		"Deprecated Features",
		"Removed Features",
		"Security Enhancements",
		"Performance Enhancements",
		"Other Changes",
	}
	ReasonInstances = []Reason{
		ReasonInvalid,
		ReasonAdded,
		ReasonFixed,
		ReasonChanged,
		ReasonDeprecated,
		ReasonRemoved,
		ReasonSecurity,
		ReasonPerformance,
		ReasonOther,
	}
)

Functions

func DefaultAuthor

func DefaultAuthor() string

func Slug

func Slug(title string) string

func TargetUiApi

func TargetUiApi() int

Types

type Entries

type Entries []*Entry

func (Entries) Authors

func (e Entries) Authors() []string

func (Entries) Filter

func (e Entries) Filter(filter func(*Entry) bool) Entries

func (Entries) FilterByComponent

func (e Entries) FilterByComponent(component string) Entries

func (Entries) FilterByReason

func (e Entries) FilterByReason(reason Reason) Entries

func (Entries) GroupByComponent

func (e Entries) GroupByComponent() map[string]Entries

func (Entries) GroupByReason

func (e Entries) GroupByReason() map[Reason]Entries

func (Entries) SortByAuthor

func (e Entries) SortByAuthor() Entries

func (Entries) SortByComponent

func (e Entries) SortByComponent() Entries

func (Entries) SortByMergeRequest

func (e Entries) SortByMergeRequest() Entries

func (Entries) SortByReason

func (e Entries) SortByReason() Entries

func (Entries) SortByTitle

func (e Entries) SortByTitle() Entries

type Entry

type Entry struct {
	Title        string `yaml:"title"`
	Author       string `yaml:"author"`
	Reason       Reason `yaml:"reason"`
	Component    string `yaml:"component,omitempty"`
	MergeRequest int    `yaml:"merge_request,omitempty"`
}

func NewEntry

func NewEntry() *Entry

func (*Entry) IsAnonymous

func (e *Entry) IsAnonymous() bool

func (*Entry) IsZero

func (e *Entry) IsZero() bool

func (*Entry) MergeRequestString

func (e *Entry) MergeRequestString() string

func (*Entry) Slug

func (e *Entry) Slug() string

func (*Entry) String

func (e *Entry) String() string

type EntryPrompt

type EntryPrompt struct {
	TargetUiApi int
}

func NewEntryPrompt

func NewEntryPrompt(targetUiApi int) *EntryPrompt

func (*EntryPrompt) Run

func (p *EntryPrompt) Run(entry *Entry) (bool, error)

type EntrySerializer

type EntrySerializer struct{}

func NewEntrySerializer

func NewEntrySerializer() *EntrySerializer

func (*EntrySerializer) Deserialize

func (s *EntrySerializer) Deserialize(data []byte) (interface{}, error)

func (*EntrySerializer) Serialize

func (s *EntrySerializer) Serialize(entry interface{}) ([]byte, error)

type Reason

type Reason int

const (
	ReasonInvalid Reason = iota
	ReasonAdded
	ReasonFixed
	ReasonChanged
	ReasonDeprecated
	ReasonRemoved
	ReasonSecurity
	ReasonPerformance
	ReasonOther
)

func ParseReason

func ParseReason(value string) (Reason, error)

func (Reason) Alias

func (r Reason) Alias() string

func (Reason) CapsString

func (r Reason) CapsString() string

func (Reason) Description

func (r Reason) Description() string

func (Reason) IsZero

func (r Reason) IsZero() bool

func (Reason) MarshalYAML

func (r Reason) MarshalYAML() (interface{}, error)

func (Reason) String

func (r Reason) String() string

func (Reason) TitleString

func (r Reason) TitleString() string

func (*Reason) UnmarshalJSON

func (r *Reason) UnmarshalJSON(value []byte) error

func (*Reason) UnmarshalText

func (r *Reason) UnmarshalText(value []byte) error

func (*Reason) UnmarshalYAML

func (r *Reason) UnmarshalYAML(value *yaml.Node) error

type Writer

type Writer struct {
	UnreleasedDir string
	Force         bool
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(output io.EntityWriter) *Writer

func (*Writer) Write

func (w *Writer) Write(e *Entry) (string, error)

func (*Writer) WriteFile

func (w *Writer) WriteFile(e *Entry, filename string) (string, error)