chlog

Documentation

Overview

Package chlog provides internal functionality for the generation of changelogs for OpenTelemetry Go projects.

Index

• Constants
• func DeleteEntries(cfg *config.Config) error
• func GenerateSummary(version string, entries []*Entry, cfg *config.Config) (string, error)
• func ReadEntries(cfg *config.Config) (map[string][]*Entry, error)
• func TemplateFuncMap() template.FuncMap
• type Entry
  • func (e Entry) Validate(requireChangelog bool, components []string, validChangeLogs ...string) error

Constants

const (
	// Breaking is a breaking change.
	Breaking = "breaking"
	// Deprecation is a deprecation change.
	Deprecation = "deprecation"
	// NewComponent is a new component change.
	NewComponent = "new_component"
	// Enhancement is an enhancement change.
	Enhancement = "enhancement"
	// BugFix is a bug fix change.
	BugFix = "bug_fix"
)

Functions

func DeleteEntries

func DeleteEntries(cfg *config.Config) error

DeleteEntries deletes changelog entries from YAML files based on the provided configuration.

func GenerateSummary

func GenerateSummary(version string, entries []*Entry, cfg *config.Config) (string, error)

GenerateSummary generates a changelog entry summary.

func ReadEntries

func ReadEntries(cfg *config.Config) (map[string][]*Entry, error)

ReadEntries reads changelog entries from YAML files based on the provided configuration.

func TemplateFuncMap

func TemplateFuncMap() template.FuncMap

TemplateFuncMap returns a map of functions to be used in the template.

Types

type Entry

type Entry struct {
	ChangeLogs []string `yaml:"change_logs"`
	ChangeType string   `yaml:"change_type"`
	Component  string   `yaml:"component"`
	Note       string   `yaml:"note"`
	Issues     []int    `yaml:"issues"`
	SubText    string   `yaml:"subtext"`
}

Entry represents a changelog entry.

func (Entry) Validate

func (e Entry) Validate(requireChangelog bool, components []string, validChangeLogs ...string) error

Validate validates the changelog entry.