releasechange

Documentation

Index

• Constants
• func RenderMarkdown(record Record, npmPackage, pythonPackage string, pypiPublished bool) string
• func RequireVersion(record Record, version string) error
• type Change
• type Migration
• type Record
  • func Admit(raw any) (Record, error)
  • func Read(path string) (Record, error)

Constants

const (
	RecordPath = "release/change-record.v2.json"
)

Functions

func RenderMarkdown

func RenderMarkdown(record Record, npmPackage, pythonPackage string, pypiPublished bool) string

func RequireVersion

func RequireVersion(record Record, version string) error

Types

type Change

type Change struct {
	ChangeID string
	Summary  string
}

type Migration

type Migration struct {
	Required bool
	Steps    []string
}

type Record

type Record struct {
	Additions            []Change
	BreakingChanges      []Change
	ChangeClass          string
	KnownLimitations     []string
	Migration            Migration
	PlatformRequirements []string
	PreviousVersion      string
	RollbackStrategy     string
	SchemaVersion        int
	Version              string
}

func Admit

func Admit(raw any) (Record, error)

func Read

func Read(path string) (Record, error)