Buf ships a binary
performs the breaking change detection functionality as a
protoc plugin. This is
useful in situations where you already have a
protoc plugin setup, such as Bazel.
All flags and config are passed as an option to the plugin as JSON. This must be done with
--buf-check-breaking_opt flag as opposed to a parameter
--buf_check_breaking_out as the option will include the ":" character as part of JSON.
The option for
protoc-gen-buf-check-breaking has the following shape:
"against_input"is required, and is limited to image formats, i.e the format must be
bin, json, and cannot be
dir, git, tar, zip.
limit_to_input_filessays to limit checks to those files under build by
protocin the current invocation, i.e. the
file_to_generatein the CodeGeneratorRequest. Generally, you will want to set this option when using this plugin. We do not make this the default to have symmetry with
buf check breaking.
From the example from the tour: