changelog

package
v0.0.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 4, 2025 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateChangelog

func GenerateChangelog(ctx context.Context, currentVersion string, repository string, cfg Config) (string, error)

GenerateChangelog generates a changelog from the git repository.

Types

type Commit

type Commit struct {
	Message   string
	Hash      string
	Variables map[string]string
}

type Config

type Config struct {
	// Specifies whether the changelog should be generated.
	Enabled bool `yaml:"enabled"`
	// Specifies the pattern to match the commits.
	Pattern string `yaml:"pattern,omitempty"`
	// Specifies the template to use for the changelog.
	Template string `yaml:"template,omitempty"`
	// Specifies the variables to use for the changelog.
	Variables map[string]string `yaml:"variables,omitempty"`
	// Specifies the URL of the VCS repository.
	VCSURL string `yaml:"-"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL