changelog

Documentation

Overview

Package changelog generates release notes from git commits.

Index

• func Run(ctx context.Context, cfg Config) (string, error)
• type Config
• type Runner
• type RunnerFunc
  • func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)

Functions

func Run

func Run(ctx context.Context, cfg Config) (string, error)

Run generates a changelog from git log using the configured runner.

Types

type Config

type Config struct {
	Log    string // git log --oneline output
	Format string // "conventional" or "prose"
	Runner Runner
}

Config holds all inputs for a changelog run.

type Runner

type Runner interface {
	Run(ctx context.Context, prompt string, tools []string) (string, error)
}

Runner is the port for LLM calls.

type RunnerFunc

type RunnerFunc func(ctx context.Context, prompt string, tools []string) (string, error)

RunnerFunc is a function adapter for Runner.

func (RunnerFunc) Run

func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)