breakingchanges

Documentation

Index

• func ShouldUpgrade(breakingChanges []BreakingChange, force bool, dryRun bool) (upgrade bool, skip bool)
• type BreakingChange
• type Change
• type Entry
• type Registry
  • func LoadRegistry() (*Registry, error)
  • func (r *Registry) Check(action string, fromVersion string, toVersion string) []BreakingChange

Functions

func ShouldUpgrade

func ShouldUpgrade(breakingChanges []BreakingChange, force bool, dryRun bool) (upgrade bool, skip bool)

Types

type BreakingChange

type BreakingChange struct {
	Type        string
	Input       string
	Replacement string
	Context     string
	Message     string
}

type Change

type Change struct {
	Type        string `yaml:"type"`
	Input       string `yaml:"input"`
	Replacement string `yaml:"replacement,omitempty"`
	Context     string `yaml:"context,omitempty"`
	Message     string `yaml:"message"`
}

type Entry

type Entry struct {
	Action    string   `yaml:"action"`
	FromMajor int      `yaml:"from_major"`
	ToMajor   int      `yaml:"to_major"`
	Changes   []Change `yaml:"changes"`
}

type Registry

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

func LoadRegistry

func LoadRegistry() (*Registry, error)

func (*Registry) Check

func (r *Registry) Check(action string, fromVersion string, toVersion string) []BreakingChange