breaking_changes

Documentation

Index

• Variables
• func FieldBecomingComputedOnlyMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldBecomingRequiredMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldChangingTypeMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldDefaultModificationMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldGrowingMinMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldOptionalComputedToOptionalMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldRemovingDiffSuppressMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func FieldShrinkingMaxMessages(resource, field string, fieldDiff diff.FieldDiff) []string
• func RemovingAFieldMessages(resource string, resourceDiff diff.ResourceDiff) []string
• func ResourceConfigRemovingAResourceMessages(resource string, resourceConfigDiff diff.ResourceConfigDiff) []string
• type BreakingChange
  • func ComputeBreakingChanges(schemaDiff diff.SchemaDiff) []BreakingChange
  • func NewBreakingChange(message, identifier string) BreakingChange
• type FieldDiffRule
• type ResourceConfigDiffRule
• type ResourceDiffRule

Variables

var FieldBecomingComputedOnly = FieldDiffRule{
	Identifier: "field-becoming-computed",
	Messages:   FieldBecomingComputedOnlyMessages,
}

var FieldBecomingRequired = FieldDiffRule{
	Identifier: "field-optional-to-required",
	Messages:   FieldBecomingRequiredMessages,
}

var FieldChangingType = FieldDiffRule{
	Identifier: "field-changing-type",
	Messages:   FieldChangingTypeMessages,
}

var FieldDefaultModification = FieldDiffRule{
	Identifier: "field-changing-default-value",
	Messages:   FieldDefaultModificationMessages,
}

var FieldDiffRules = []FieldDiffRule{
	FieldChangingType,
	FieldBecomingRequired,
	FieldBecomingComputedOnly,
	FieldOptionalComputedToOptional,
	FieldDefaultModification,
	FieldGrowingMin,
	FieldShrinkingMax,
	FieldRemovingDiffSuppress,
}

FieldDiffRules is a list of FieldDiffRule guarding against provider breaking changes

var FieldGrowingMin = FieldDiffRule{
	Identifier: "field-growing-min",
	Messages:   FieldGrowingMinMessages,
}

var FieldOptionalComputedToOptional = FieldDiffRule{
	Identifier: "field-oc-to-c",
	Messages:   FieldOptionalComputedToOptionalMessages,
}

var FieldRemovingDiffSuppress = FieldDiffRule{
	Identifier: "field-removing-diff-suppress",
	Messages:   FieldRemovingDiffSuppressMessages,
}

var FieldShrinkingMax = FieldDiffRule{
	Identifier: "field-shrinking-max",
	Messages:   FieldShrinkingMaxMessages,
}

var RemovingAField = ResourceDiffRule{
	Identifier: "resource-schema-field-removal-or-rename",
	Messages:   RemovingAFieldMessages,
}

var ResourceConfigDiffRules = []ResourceConfigDiffRule{ResourceConfigRemovingAResource}

ResourceConfigDiffRules is a list of ResourceConfigDiffRule guarding against provider breaking changes

var ResourceConfigRemovingAResource = ResourceConfigDiffRule{
	Identifier: "resource-map-resource-removal-or-rename",
	Messages:   ResourceConfigRemovingAResourceMessages,
}

var ResourceDiffRules = []ResourceDiffRule{RemovingAField}

ResourceDiffRules is a list of all ResourceDiff rules

Functions

func FieldBecomingComputedOnlyMessages

func FieldBecomingComputedOnlyMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldBecomingRequiredMessages

func FieldBecomingRequiredMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldChangingTypeMessages

func FieldChangingTypeMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldDefaultModificationMessages

func FieldDefaultModificationMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldGrowingMinMessages

func FieldGrowingMinMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldOptionalComputedToOptionalMessages

func FieldOptionalComputedToOptionalMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldRemovingDiffSuppressMessages

func FieldRemovingDiffSuppressMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func FieldShrinkingMaxMessages

func FieldShrinkingMaxMessages(resource, field string, fieldDiff diff.FieldDiff) []string

func RemovingAFieldMessages

func RemovingAFieldMessages(resource string, resourceDiff diff.ResourceDiff) []string

TODO: Make field removal a FieldDiffRule b/300124253

func ResourceConfigRemovingAResourceMessages

func ResourceConfigRemovingAResourceMessages(resource string, resourceConfigDiff diff.ResourceConfigDiff) []string

Types

type BreakingChange

type BreakingChange struct {
	Resource               string
	Field                  string
	Message                string
	DocumentationReference string
	RuleName               string
}

func ComputeBreakingChanges

func ComputeBreakingChanges(schemaDiff diff.SchemaDiff) []BreakingChange

func NewBreakingChange

func NewBreakingChange(message, identifier string) BreakingChange

type FieldDiffRule

type FieldDiffRule struct {
	Identifier string
	Messages   func(resource, field string, fieldDiff diff.FieldDiff) []string
}

FieldDiffRule provides structure for rules regarding field attribute changes

type ResourceConfigDiffRule

type ResourceConfigDiffRule struct {
	Identifier string
	Messages   func(resource string, resourceConfigDiff diff.ResourceConfigDiff) []string
}

ResourceConfigDiffRule provides structure for rules regarding resource config changes

type ResourceDiffRule

type ResourceDiffRule struct {
	Identifier string
	Messages   func(resource string, resourceDiff diff.ResourceDiff) []string
}

ResourceDiffRule is a rule that operates on an entire ResourceDiff