theme

Documentation

Overview

Package theme uses AI to group commits into thematic sections instead of conventional commit types.

Index

• func Markdown(tr ThemedReport) ([]byte, error)
• type Options
• type ThemeGroup
• type ThemedReport
  • func GroupCommits(ctx context.Context, report render.Report, aiClient ai.Client, opts Options) (ThemedReport, error)

Functions

func Markdown

func Markdown(tr ThemedReport) ([]byte, error)

Types

type Options

type Options struct {
	MinThemes        int
	MaxThemes        int
	IncludeNarrative bool
}

type ThemeGroup

type ThemeGroup struct {
	Title     string
	Narrative string
	Items     []render.Item
}

type ThemedReport

type ThemedReport struct {
	Version           string
	Date              string
	Breaking          []render.Item
	Themes            []ThemeGroup
	CompareURL        string
	ShowAuthor        bool
	Emojis            bool
	CommitURLTemplate string
	IssueURLTemplate  string
	Repo              string
}

func GroupCommits

func GroupCommits(ctx context.Context, report render.Report, aiClient ai.Client, opts Options) (ThemedReport, error)