notes

Documentation

Overview

Package notes wraps engine interfaces with common logic unrelated to any particular engine implementation.

Index

• type BuildRequest
• type Builder
  • func NewBuilder(cfg Config, eval *eval.Evaluator, extras map[string]string) (*Builder, error)
  • func (s *Builder) Build(ctx context.Context, req BuildRequest) (string, error)
• type CategoryConfig
• type Config
  • func ConfigFromFile(path string) (Config, error)
• type EvalAddon
  • func (e *EvalAddon) Funcs(ctx context.Context) (template.FuncMap, error)
  • func (e *EvalAddon) String() string
• type LoadedTree
• type TicketNode
  • func (t *TicketNode) GetTicket() task.Ticket

Types

type BuildRequest

type BuildRequest struct {
	From      string
	To        string
	ClosedPRs []git.PullRequest
	Commits   []git.Commit
}

BuildRequest is a request for changelog building.

type Builder

type Builder struct {
	Config
	Evaluator *eval.Evaluator
	Extras    map[string]string
	// contains filtered or unexported fields
}

Builder provides methods to form changelog.

func NewBuilder

func NewBuilder(cfg Config, eval *eval.Evaluator, extras map[string]string) (*Builder, error)

NewBuilder creates a new Builder.

func (*Builder) Build

func (s *Builder) Build(ctx context.Context, req BuildRequest) (string, error)

Build builds the changelog for the tag.

type CategoryConfig

type CategoryConfig struct {
	Title  string   `yaml:"title"`
	Labels []string `yaml:"labels"`

	Branch        string `yaml:"branch"`         // regexp to match source branch name
	CommitMessage string `yaml:"commit_message"` // regexp to match commit message

	// next fields are used internally
	BranchRe    *regexp.Regexp `yaml:"-"`
	CommitMsgRe *regexp.Regexp `yaml:"-"`
}

CategoryConfig describes the category configuration.

type Config

type Config struct {
	Categories []CategoryConfig `yaml:"categories"` // categories to parse in pull requests

	// field, by which pull requests must be sorted, in format +|-field
	// currently supported fields: number, author, title, closed
	SortField string `yaml:"sort_field"`

	Template     string   `yaml:"template"`      // template for a changelog.
	UnusedTitle  string   `yaml:"unused_title"`  // if set, the unused category will be built under this title at the, end of the changelog
	IgnoreLabels []string `yaml:"ignore_labels"` // labels for pull requests, which won't be in release notes
}

Config describes the configuration of the changelog builder.

func ConfigFromFile

func ConfigFromFile(path string) (Config, error)

ConfigFromFile reads the configuration from the file.

type EvalAddon

type EvalAddon struct {
	TaskTracker *tengine.Tracker
}

EvalAddon is an addon to evaluator, to be used in release notes template.

func (*EvalAddon) Funcs

func (e *EvalAddon) Funcs(ctx context.Context) (template.FuncMap, error)

Funcs returns a map of functions to be used in release notes template.

func (*EvalAddon) String

func (e *EvalAddon) String() string

String returns addon name.

type LoadedTree

type LoadedTree struct {
	Roots             []*TicketNode
	UnattachedPRs     []git.PullRequest
	UnattachedCommits []git.Commit
}

LoadedTree is a tree of tickets with their children and PRs.

type TicketNode

type TicketNode struct {
	task.Ticket
	Children []*TicketNode
	PRs      []git.PullRequest
	Commits  []git.Commit
}

TicketNode is a representation of a ticket with its children.

func (*TicketNode) GetTicket

func (t *TicketNode) GetTicket() task.Ticket

GetTicket returns the ticket. FIXME: this is ugly, but it's needed to match the interface for embedded structs.