changelog

Documentation

Index

• type Change
• type Changes
  • func CollectChanges(opts Options) (Changes, error)
• type Options
• type TitleChanges
  • func GroupByTitleFunc(g Changes, f func(Change) (string, int, bool)) ([]TitleChanges, error)

Types

type Change

type Change struct {
	// Fetched from git log.
	Hash    string
	Author  string
	Subject string
	Body    string

	Issues []int

	// Resolved from GitHub.
	Username string
}

Change represents a git commit.

type Changes

type Changes []Change

Changes represents a list of git commits.

func CollectChanges

func CollectChanges(opts Options) (Changes, error)

CollectChanges collects changes according to the given options. If opts.ResolveUserName is set, it will be used to resolve Change.Username (e.g. GitHub login).

type Options

type Options struct {
	// Can be nil.
	// ResolveUserName returns the username for the given author (email address) and commit sha.
	// This is the GitHub login (e.g. bep) in its first iteration.
	ResolveUserName func(commit, author string) (string, error)

	// All of these can be empty.
	PrevTag   string
	Tag       string
	Commitish string
	RepoPath  string
}

Options for collecting changes.

type TitleChanges

type TitleChanges struct {
	Title   string
	Changes Changes
	// contains filtered or unexported fields
}

TitleChanges represents a list of changes grouped by title.

func GroupByTitleFunc

func GroupByTitleFunc(g Changes, f func(Change) (string, int, bool)) ([]TitleChanges, error)

GroupByTitleFunc groups g by title according to the grouping function f. If f returns false, that change item is not included in the result.