Documentation
¶
Overview ¶
Package compat checks backward compatibility between schema versions. It walks both descriptor trees and reports violations that would break existing consumers relying on protobuf wire compatibility.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Result ¶
type Result struct {
Violations []Violation
}
Result holds the outcome of a compatibility check.
func Check ¶
Check compares old and new snapshots for backward compatibility violations. It checks all files in the old snapshot against corresponding files in the new snapshot.
type Violation ¶
type Violation struct {
// File is the proto file where the violation occurred.
File string
// Path is the fully-qualified path of the element (e.g. "acme.Config.timeout_ms").
Path string
// Rule is the machine-readable rule identifier.
Rule string
// Message is a human-readable description.
Message string
}
Violation describes a single backward compatibility violation.
Source Files
Click to show internal directories.
Click to hide internal directories.