changelog

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Change

type Change struct {
	Description string
}

type ChangeGroup

type ChangeGroup struct {
	Tag            string
	Date           *string
	LabeledChanges map[string][]Change
}

type ChangelogGenerator

type ChangelogGenerator struct {
}

func NewChangelogGenerator

func NewChangelogGenerator() *ChangelogGenerator

func (*ChangelogGenerator) Generate

func (g *ChangelogGenerator) Generate(sourceRepo Repository, cfg GenerateConfig) ([]byte, error)

type Commit

type Commit struct {
	Message string
	Date    string
	Tag     *string
}

type GenerateConfig

type GenerateConfig struct {
	SinceTag       string
	UntilTag       string
	GroupByPattern string
	SkipPattern    string
}

type Repository

type Repository interface {
	Name() string
	TraverseHistory(func(c Commit) error) error
}

type SingleProjectTemplateData

type SingleProjectTemplateData struct {
	ProjectName       string
	ChangeGroups      []ChangeGroup
	FilterDeclaration string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL