changelog

Documentation

Index

• func Command(ctx context.Context, logger *log.Logger) *cobra.Command
• type ChangeLog
  • func GenerateReleaseNotes(globalCtx context.Context, ghClient *gh.Client, logger Printer, ...) (*ChangeLog, error)
  • func (cl *ChangeLog) AllPRs() (map[int]struct{}, types.NodeIDs)
  • func (cl *ChangeLog) PrintReleaseNotes()
  • func (cl *ChangeLog) PrintReleaseNotesForWriter(w io.Writer)
• type ChangeLogConfig
  • func (cfg *ChangeLogConfig) Sanitize() error
• type Printer

Functions

func Command

func Command(ctx context.Context, logger *log.Logger) *cobra.Command

Types

type ChangeLog

type ChangeLog struct {
	ChangeLogConfig
	Logger Printer
	// contains filtered or unexported fields
}

func GenerateReleaseNotes

func GenerateReleaseNotes(globalCtx context.Context, ghClient *gh.Client, logger Printer, cfg ChangeLogConfig) (*ChangeLog, error)

func (*ChangeLog) AllPRs

func (cl *ChangeLog) AllPRs() (map[int]struct{}, types.NodeIDs)

AllPRs returns all PRs that are part the changelog.

func (*ChangeLog) PrintReleaseNotes

func (cl *ChangeLog) PrintReleaseNotes()

func (*ChangeLog) PrintReleaseNotesForWriter

func (cl *ChangeLog) PrintReleaseNotesForWriter(w io.Writer)

type ChangeLogConfig

type ChangeLogConfig struct {
	types.CommonConfig

	Base                string
	Head                string
	LastStable          string
	StateFile           string
	LabelFilters        []string
	ReleaseLabels       []string
	ExcludeLabels       []string
	ExcludePRReferences bool
	SkipHeader          bool
}

func (*ChangeLogConfig) Sanitize

func (cfg *ChangeLogConfig) Sanitize() error

type Printer

type Printer interface {
	Printf(format string, v ...any)
	Println(v ...any)
}