Releases: bufbuild/buf
v1.32.2
- Update
buf generate
to warn instead of error when proto3 optional is required but not supported by a plugin.
v1.32.1
- Fix archive and git inputs so that
--path
and--exclude-path
paths are relative to the#subdir
rather than the root of the input. This fixes an unintended behavior change that was introduced inv1.32.0
. - Add
module
input forprotoc-gen-buf-lint
andprotoc-gen-buf-breaking
to allow users to specify the module forv2
configuration files.
v1.32.0
This release contains the (completely backwards-compatible) next generation of the Buf CLI. The Buf CLI and its associated configuration have been completely overhauled to support monorepos as first-class citizens. We'd call it a v2 of buf, but it's not. Buf is enterprise-grade software, and we want you to be minimally impacted. The v1.32.0
release of buf introduces v2
config formats for both buf.yaml
and buf.gen.yaml
. All your current commands and v1
configuration continue to work, so you can upgrade to v2
configuration when appropriate.
To read more about what's new, check out our blog and our docs:
- Introducing the next generation of the Buf CLI: still v1 and backwards-compatible
- Introducing the newly improved BSR UI and buf push experience
- Migrate to v2 configuration files
- Add version
v2
forbuf.yaml
andbuf.gen.yaml
configuration files. - Add
buf config migrate
to migrate configuration files to the latest version (nowv2
). - Move
buf mod init
tobuf config init
.buf mod init
is now deprecated. - Move
buf mod ls-lint-rules
tobuf config ls-lint-rules
.buf mod ls-lint-rules
is now deprecated. - Move
buf mod ls-breaking-rules
tobuf config ls-breaking-rules
.buf mod ls-breaking-rules
is now deprecated. - Move
buf mod prune
tobuf dep prune
.buf mod prune
is now deprecated. - Move
buf mod update
tobuf dep update
.buf mod update
is now deprecated. - Move
buf mod {clear-cache,cc}
tobuf registry cc
.buf mod {clear-cache,cc}
is now deprecated. - Move
buf beta graph
to stable asbuf dep graph
. - Change the default visibility of
buf push --create-visibility
toprivate
when the--create
flag is set. Users are no longer required to set--create-visibility
when runningbuf push --create
. - Add
buf push --label
, which allows users to set labels when pushing new commits to the BSR. - Add
buf push --source-control-url
, which allows users to associate commits pushed to the BSR with a URL to a source code repository. - Add
buf push --create-default-label
, which allows users to set a default label for a repository when callingbuf push --create
. - Add
buf push --git-metadata
, which automatically sets appropriate--label
,--source-control-url
, and--create-default-label
flags based on the current Git repository. - Add
buf convert --validate
to apply protovalidate rules to incoming messages specified with--from
. - Deprecate
buf mod open
. - Delete
buf beta migrate-v1beta1
This is now replaced withbuf config migrate
. - Add
buf registry sdk version
to get the version of a Generated SDK for a module and plugin. - Add
buf beta registry archive
andbuf beta registry unarchive
commands for archiving and unarchiving labels on the BSR. - Add support for Protobuf Editions. This allows
buf
to be used with sources that use edition 2023, instead of proto2 or proto3 syntax. This also updates theprotoc-gen-buf-breaking
andprotoc-gen-buf-lint
Protobuf plugins to support files that use edition 2023. - Update
buf breaking
rules to work with Protobuf Editions. To support Editions, some rules have been deprecated and replaced with Editions-aware rules. All deprecated rules continue to work for existing users.FIELD_SAME_CTYPE
has been replaced withFIELD_SAME_CPP_STRING_TYPE
, which considers bothctype
field options and new(pb.cpp).string_type
features when deciding on backwards compatibility.FIELD_SAME_LABEL
has been replaced with three rules that all check "cardinality". The new rules can distinguish between maps and other repeated fields and between implicit and explicit field presence. The new rules are:FIELD_SAME_CARDINALITY
in theFILE
andPACKAGE
categories.FIELD_WIRE_COMPATIBLE_CARDINALITY
in theWIRE
category.FIELD_WIRE_JSON_COMPATIBLE_CARDINALITY
in theWIRE_JSON
category.
FILE_SAME_JAVA_STRING_CHECK_UTF8
has been replaced withFIELD_SAME_JAVA_UTF8_VALIDATION
, which considers both thejava_string_check_utf8
file option and(pb.java).utf8_validation
features when deciding on backwards compatibility.- Add to the existing
FILE_SAME_SYNTAX
rule with a few related rules that can catch the same sort of compatibility issues, but in an Editions source file that changes feature values:MESSAGE_SAME_JSON_FORMAT
andENUM_SAME_JSON_FORMAT
catch changes to thejson_format
feature, which controls whether support for the JSON format is best-effort or properly supported. When supported, the compiler performs more checks relating to field name collisions for the JSON format as well as for FieldMask usage.FIELD_SAME_UTF8_VALIDATION
catches changes to theutf8_validation
feature, which controls validation of string values.ENUM_SAME_TYPE
catches changes to an enum's type, open vs. closed.
- Add support for extensions to
buf breaking
. All existing rules for fields are now applied to extensions, except forFIELD_NO_DELETE
(and its variants). There are also newEXTENSION_NO_DELETE
andPACKAGE_EXTENSION_NO_DELETE
rules for catching deletions of an extension. The new rules are not active by default in existingv1
andv1beta1
configurations, for backwards-compatibility reasons. Migrate your config tov2
to use them. - Add support for top-level extensions to
buf lint
. It previously only checked extensions that were defined inside of messages. - Add a new
FIELD_NOT_REQUIRED
lint rule that prevents use of required in proto2 files and offeatures.field_presence = LEGACY_REQUIRED
in Editions files. This new rule is not active by default in existingv1
andv1beta1
configurations, for backwards-compatibility reasons. Migrate your config tov2
to use them.
v1.32.0-beta.1
This is the first beta release of the next generation of the Buf CLI. This beta release is being used by some of our customers to ensure we've kept compatibility, and to try some of its new features. Don't worry - the next generation of the buf
CLI continues to be v1
, and is completely backwards-compatible - all of your workflows will continue to work. Buf is enterprise-grade software, and we want you to be minimally impacted.
There's some exciting improvements coming in the next generation of the buf
CLI, and we look forward to sharing it more widely in the coming weeks. If you'd like to be part of the private beta, email us with the subject line "Beta" and we'll be happy to talk - we'll add more users as we have capacity. While you are free to give this beta release a spin without being added to our private beta, we wouldn't recommend using it outside of our private beta just yet!
v1.31.0
- Update dependencies.
v1.30.1
- Fix issue where
buf lint
incorrectly reports an error for(buf.validate.field).repeated
is set for a repeated validation rule.
v1.30.0
- Update
buf generate
so it populates the recently-addedsource_file_descriptors
field of theCodeGeneratorRequest
message. This provides the plugin with access to options that are configured to only be retained in source and not at runtime (via field option). Descriptors in theproto_file
field will not include any options configured this way for the files named infile_to_generate
field. - Add
--exclude-source-retention-options
flag tobuf build
, which causes options configured to only be retained in source to be stripped from the output descriptors.
v1.29.0
- Add support for
yaml
format. All commands that take image inputs, output images, or convert between message formats, now takeyaml
as a format, in addition to the existingbinpb
andtxtpb
formats. Some examples:buf build -o image.yaml
buf ls-files image.yaml
buf convert --type foo.Bar --from input.binpb --to output.yaml
- The
yaml
andjson
formats now accept two new options:use_proto_names
anduse_enum_numbers
. This affects output serialization. Some examples:buf convert --type foo.Bar --from input.binpb --to output.yaml#use_proto_names=true
buf convert --type foo.Bar --from input.binpb --to -#format=yaml,use_enum_numbers=true
- Fix issue where
buf format
would inadvertently mangle files that used the expandedAny
syntax in option values.
v1.28.1
- The
buf curl
command has been updated to support the use of multiple schemas. This allows users to specify multiple--schema
flags and/or to use both--schema
and--reflect
flags at the same time. The result is that additional sources can be consulted to resolve an element. This can be useful when the result of an RPC contains extensions or values ingoogle.protobuf.Any
messages that are not defined in the same schema that defines the RPC service. - Fix issue where
buf lint
incorrectly reports error when(buf.validate.field).required
is set for an optional field in proto3.
v1.28.0
- Add lint rules for protovalidate.
buf lint
will now verify that your protovalidate rules are valid. A single rulePROTOVALIDATE
has been added to theDEFAULT
group - given that protovalidate is net new, this does not represent a breaking change. - Update
buf beta price
with the latest pricing information. - Display a warning when reading a
buf.lock
with dependencies with b1 or b3 digests. b1 and b3 digests will be deprecated in a future version. Runbuf mod update
to update dependency digests.