multirepo

Documentation

Overview

Package multirepo aggregates changelogs from multiple repositories into a single document.

Index

• func FormatAggregateMarkdown(results []RepoResult, showAuthor bool, useEmoji bool) []byte
• type AggregateOptions
• type RepoResult
  • func Aggregate(ctx context.Context, repoPaths []string, cfg config.Config, ...) []RepoResult

Functions

func FormatAggregateMarkdown

func FormatAggregateMarkdown(results []RepoResult, showAuthor bool, useEmoji bool) []byte

Types

type AggregateOptions

type AggregateOptions struct {
	From       string
	To         string
	Filter     string
	Classify   bool
	Thresholds classify.Thresholds
}

type RepoResult

type RepoResult struct {
	Name    string
	Path    string
	Version string
	Report  render.Report
	Commits []commit.Commit
	Error   error
}

func Aggregate

func Aggregate(ctx context.Context, repoPaths []string, cfg config.Config, opts AggregateOptions) []RepoResult