bufbreaking

Documentation

Overview

Package bufbreaking contains the breaking change detection functionality.

The primary entry point to this package is the Handler.

Index

• func GetAllRules(fileVersion bufconfig.FileVersion) ([]bufcheck.Rule, error)
• func GetAllRulesV1() ([]bufcheck.Rule, error)
• func GetAllRulesV1Beta1() ([]bufcheck.Rule, error)
• func GetAllRulesV2() ([]bufcheck.Rule, error)
• func GetRelevantDeprecations(fileVersion bufconfig.FileVersion) (map[string][]string, error)
• func RulesForConfig(config bufconfig.BreakingConfig) ([]bufcheck.Rule, error)
• type Handler
  • func NewHandler(logger *zap.Logger, tracer tracing.Tracer) Handler

Functions

func GetAllRules

func GetAllRules(fileVersion bufconfig.FileVersion) ([]bufcheck.Rule, error)

GetAllRules gets all known rules for the given version.

Should only be used for testing.

func GetAllRulesV1

func GetAllRulesV1() ([]bufcheck.Rule, error)

GetAllRulesV1 gets all known rules.

Should only be used for printing.

func GetAllRulesV1Beta1

func GetAllRulesV1Beta1() ([]bufcheck.Rule, error)

GetAllRulesV1Beta1 gets all known rules.

Should only be used for printing.

func GetAllRulesV2

func GetAllRulesV2() ([]bufcheck.Rule, error)

GetAllRulesV2 gets all known rules.

Should only be used for printing.

func GetRelevantDeprecations

func GetRelevantDeprecations(fileVersion bufconfig.FileVersion) (map[string][]string, error)

GetRelevantDeprecations gets deprecation information for the given version. The map is from deprecated rule IDs to zero or more replacement rule IDs.

func RulesForConfig

func RulesForConfig(config bufconfig.BreakingConfig) ([]bufcheck.Rule, error)

RulesForConfig returns the rules for a given config.

Does NOT include deprecated rules.

Should only be used for printing.

Types

type Handler

type Handler interface {
	// Check runs the breaking checks.
	//
	// The image should have source code info for this to work properly. The previousImage
	// does not need to have source code info.
	//
	// Images should be filtered with regards to imports before passing to this function.
	//
	// An error of type bufanalysis.FileAnnotationSet will be returned on breaking failure.
	Check(
		ctx context.Context,
		config bufconfig.BreakingConfig,
		previousImage bufimage.Image,
		image bufimage.Image,
	) error
}

Handler handles the main breaking functionality.

func NewHandler

func NewHandler(logger *zap.Logger, tracer tracing.Tracer) Handler

NewHandler returns a new Handler.