release

Documentation

Index

• type Change
• type Generator
  • func NewGenerator(version, commit, outputDir string, logger *slog.Logger) *Generator
  • func (g *Generator) GenerateChangelog(changes []Change) error
  • func (g *Generator) GenerateChecksums(artifactsDir string) error
  • func (g *Generator) GenerateDockerManifest(images []string) error
  • func (g *Generator) GenerateInstallScript() error
  • func (g *Generator) GeneratePackageScripts() error
  • func (g *Generator) GenerateReleaseNotes(since string) (string, error)
• type ReleaseNotes

Types

type Change

type Change struct {
	Type     string
	Scope    string
	Message  string
	Commit   string
	Author   string
	Date     time.Time
	Breaking bool
}

Change represents a single change

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator handles release artifact generation

func NewGenerator

func NewGenerator(version, commit, outputDir string, logger *slog.Logger) *Generator

NewGenerator creates a new release generator

func (*Generator) GenerateChangelog

func (g *Generator) GenerateChangelog(changes []Change) error

GenerateChangelog updates the CHANGELOG.md file

func (*Generator) GenerateChecksums

func (g *Generator) GenerateChecksums(artifactsDir string) error

GenerateChecksums generates SHA256 checksums for all artifacts

func (*Generator) GenerateDockerManifest

func (g *Generator) GenerateDockerManifest(images []string) error

GenerateDockerManifest generates Docker image manifest

func (*Generator) GenerateInstallScript

func (g *Generator) GenerateInstallScript() error

GenerateInstallScript generates installation script

func (*Generator) GeneratePackageScripts

func (g *Generator) GeneratePackageScripts() error

GeneratePackageScripts generates package installation scripts

func (*Generator) GenerateReleaseNotes

func (g *Generator) GenerateReleaseNotes(since string) (string, error)

GenerateReleaseNotes generates release notes from git history

type ReleaseNotes

type ReleaseNotes struct {
	Version  string
	Commit   string
	Date     time.Time
	Sections map[string][]Change
}

ReleaseNotes contains all release note data