bufbreaking

Documentation

Overview

Package bufbreaking contains the breaking change detection functionality.

The primary entry point to this package is the Handler.

Index

• func GetAllRulesAndCategoriesV1() []string
• func GetAllRulesAndCategoriesV1Beta1() []string
• func GetAllRulesV1() ([]bufcheck.Rule, error)
• func GetAllRulesV1Beta1() ([]bufcheck.Rule, error)
• func RulesForConfig(config *bufbreakingconfig.Config) ([]bufcheck.Rule, error)
• type Handler
  • func NewHandler(logger *zap.Logger) Handler

Functions

func GetAllRulesAndCategoriesV1

func GetAllRulesAndCategoriesV1() []string

GetAllRulesAndCategoriesV1 returns all rules and categories for v1 as a string slice.

This is used for validation purposes only.

func GetAllRulesAndCategoriesV1Beta1

func GetAllRulesAndCategoriesV1Beta1() []string

GetAllRulesAndCategoriesV1Beta1 returns all rules and categories for v1beta1 as a string slice.

This is used for validation purposes only.

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 RulesForConfig

func RulesForConfig(config *bufbreakingconfig.Config) ([]bufcheck.Rule, error)

RulesForConfig returns the rules for a given config.

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.
	Check(
		ctx context.Context,
		config *bufbreakingconfig.Config,
		previousImage bufimage.Image,
		image bufimage.Image,
	) ([]bufanalysis.FileAnnotation, error)
}

Handler handles the main breaking functionality.

func NewHandler

func NewHandler(logger *zap.Logger) Handler

NewHandler returns a new Handler.