Skip to content

Commit

Permalink
Intentionally broke breaking change detector
Browse files Browse the repository at this point in the history
  • Loading branch information
melinath committed Aug 22, 2023
1 parent bfd5b92 commit bcb6ba8
Showing 1 changed file with 0 additions and 56 deletions.
56 changes: 0 additions & 56 deletions tools/breaking-change-detector/rules/rule.go
Original file line number Diff line number Diff line change
@@ -1,56 +0,0 @@
package rules

// Rule is an interface that all Rule
// types implement. This give consistency
// for the potential documentation generation.
type Rule interface {
Name() string
Definition() string
Identifier() string
Undetectable() bool
}

// RuleCategory holds documentation and
// inventory for each of the rule types
type RuleCategory struct {
Name string
Definition string
Rules []Rule
}

// Rules is a type to hold all existing
// rules. Exposed for potential documentation generator
type Rules struct {
Categories []RuleCategory
}

// GetRules returns a list of all rules for
// potential documentation generation
func GetRules() *Rules {
categories := []RuleCategory{
{
Name: "Provider Configuration Level Breakages",
Definition: "Top level behavior such as provider configuration and authentication changes.",
Rules: providerConfigRulesToRuleArray(ProviderConfigRules),
},
{
Name: "Resource List Level Breakages",
Definition: "Resource/datasource naming conventions and entry differences.",
Rules: resourceInventoryRulesToRuleArray(ResourceInventoryRules),
},
{
Name: "Resource Level Breakages",
Definition: "Individual resource breakages like field entry removals or behavior within a resource.",
Rules: resourceSchemaRulesToRuleArray(ResourceSchemaRules),
},
{
Name: "Field Level Breakages",
Definition: "Field level conventions like attribute changes and naming conventions.",
Rules: fieldRulesToRuleArray(FieldRules),
},
}

return &Rules{
Categories: categories,
}
}

0 comments on commit bcb6ba8

Please sign in to comment.