diff

Documentation

Overview

Package diff compares two versions of a specification element by element and classifies each difference by the version step it needs, as docs/maintenance.md (The diff verb) describes.

Index

• type Change
  • func Compare(oldRoot, newRoot *yaml.Node) []Change
  • func (c Change) String() string

Types

type Change

type Change struct {
	Pointer string // the element, such as /entities/Loan
	What    string // added, changed or removed
	Impact  int    // semver.Patch, semver.Minor or semver.Major
	Reason  string // for a changed element of the public interface, the change that decided its impact
}

Change is one element that differs between the two versions.

func Compare

func Compare(oldRoot, newRoot *yaml.Node) []Change

Compare lists the elements that differ between two merged specifications, in pointer order.

func (Change) String

func (c Change) String() string

String is the line the diff verb prints.