changelog

Documentation

Index

• type Changelog
  • func (c Changelog) HasBreakingChanges() bool
  • func (c Changelog) String() string
  • func (c Changelog) ToMarkdown() string
• type Exporter
  • func (p Exporter) ExportForPackage(relPkgDir string) (*Changelog, error)

Types

type Changelog

type Changelog struct {
	PackageName    string
	NewPackage     bool
	RemovedPackage bool
	Modified       *report.Package
}

Changelog describes a changelog of the package during this generation

func (Changelog) HasBreakingChanges

func (c Changelog) HasBreakingChanges() bool

HasBreakingChanges returns if this report of changelog contains breaking changes

func (Changelog) String

func (c Changelog) String() string

func (Changelog) ToMarkdown

func (c Changelog) ToMarkdown() string

ToMarkdown returns the markdown string of this changelog

type Exporter

type Exporter struct {
	// SDKRoot ...
	SDKRoot string
	// BackupRoot ...
	BackupRoot string
}

Exporter ...

func (Exporter) ExportForPackage

func (p Exporter) ExportForPackage(relPkgDir string) (*Changelog, error)

ExportForPackage generates the Changelog for the given relPkgDir relPkgDir is the package path relative to the root of SDK, e.g. services/compute/mgmt/2020-06-01/compute