Skip to content

Latest commit

 

History

History
1161 lines (872 loc) · 65.2 KB

CHANGELOG.md

File metadata and controls

1161 lines (872 loc) · 65.2 KB
Raw

Changelog

Unreleased

  • No changes yet.

v1.30.1 - 2024-04-03

  • Fix issue where buf lint incorrectly reports an error for (buf.validate.field).repeated is set for a repeated validation rule.

v1.30.0 - 2024-03-07

  • Update buf generate so it populates the recently-added source_file_descriptors field of the CodeGeneratorRequest 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 the proto_file field will not include any options configured this way for the files named in file_to_generate field.
  • Add --exclude-source-retention-options flag to buf build, which causes options configured to only be retained in source to be stripped from the output descriptors.

v1.29.0 - 2024-01-24

  • Add support for yaml format. All commands that take image inputs, output images, or convert between message formats, now take yaml as a format, in addition to the existing binpb and txtpb 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 and json formats now accept two new options: use_proto_names and use_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 expanded Any syntax in option values.

v1.28.1 - 2023-11-15

  • 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 in google.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 - 2023-11-10

  • Add lint rules for protovalidate. buf lint will now verify that your protovalidate rules are valid. A single rule PROTOVALIDATE has been added to the DEFAULT 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. Run buf mod update to update dependency digests.

v1.27.2 - 2023-10-27

  • Fix issue where buf build and other commands may fail when handling certain archives created on macOS that contain files with extended attributes.

v1.27.1 - 2023-10-16

  • Fix issue in v1.27.0 where --path did not work with workspaces under certain scenarios.

v1.27.0 - 2023-10-04

  • Fix issue where buf generate --exclude-path was not properly excluding paths for remote modules.
  • Fix issue where buf curl had a user agent that did not properly place the extension as a suffix.
  • Update buf beta price with the latest pricing information.

v1.26.1 - 2023-08-09

  • Fix issue where buf build -o did not properly output files with the .txtpb extension in Protobuf text format.

v1.26.0 - 2023-08-09

  • Add support for the --http2-prior-knowledge flag when running buf curl against secure "https" URLs. This can be used with gRPC servers, that only support HTTP/2, when used with a network (layer 4) load balancer, that does not support protocol negotiation in TLS handshake.

v1.25.1 - 2023-08-02

  • Fix issue where all files were being iterated over when using the --path flag.
  • Fix issue where the directory . was incorrectly accepted as a value for the directories key in buf.work.yaml.

v1.25.0 - 2023-07-18

  • Add txtpb format to handle the Protobuf text format. and automatically recognize .txtpb files as Protobuf text files. The txtpb format can now be used with all buf commands that take images as input or output, such as build, convert, and curl.

v1.24.0 - 2023-07-13

  • Update buf mod update to block updates that will result in conflicting .proto files across dependencies.
  • Replace bin format with binpb format, and support the .binpb file extension. .binpb is now the canonical file extension for binary-encoded Protobuf data. The bin format and the .bin file extension continue to be accepted.
  • Remove support for go subdomain in .netrc. This was used as part of the remote generation alpha, which has been fully deprecated in favor of remote plugins and remote packages. See https://buf.build/blog/remote-packages-remote-plugins-approaching-v1 for more details.
  • Update buf beta price with the latest pricing information.

v1.23.1 - 2023-06-30

  • Fix issue where buf beta graph would not print modules within a workspace that had no dependencies or dependents.
  • Fix issue where buf beta graph would print warnings for missing dependencies that were actually present.

v1.23.0 - 2023-06-29

  • Add buf beta graph to print the dependency graph for a module in DOT format.
  • Various small bug fixes.

v1.22.0 - 2023-06-23

  • Change default for --origin flag of buf beta studio-agent to https://buf.build

v1.21.0 - 2023-06-05

  • Fix issue where locally-produced images did not have module information if the corresponding module was stored in the new cache.
  • Remove buf beta registry template.
  • Remove buf beta registry plugin {create,deprecate,list,undeprecate,version} and replace with buf beta registry plugin {push,delete}.
  • Update buf beta price with the latest pricing information.

v1.20.0 - 2023-05-30

  • Add --emit-defaults flag to buf curl to emit default values in JSON-encoded responses.
  • Indent JSON-encoded responses from buf curl by default.
  • Log a warning in case an import statement does not point to a file in the module, a file in a direct dependency, or a well-known type file.

v1.19.0 - 2023-05-17

  • Add --create flag to buf push to create a repository if it does not exist. The user is also required to specify the visibility using --create-visibility.
  • Add github-actions error format to print errors in a form parseable by GitHub Actions.
  • Fix issue in buf build and buf generate where the use of type filtering (via --type flags) would cause the resulting image to have no source code info, even when --exclude-source-info was not specified. The main impact of the bug was that generated code would be missing comments.
  • Fix issue in buf curl when using --user or --netrc that would cause a malformed Authorization header to be sent.
  • Update the module cache to use an optimized content addressable store. The cache is now self-healing and uses significantly less space. Users wishing to free unused space can run buf mod --clear-cache once after upgrading to remove data stored in the previous module cache.

v1.18.0 - 2023-05-05

  • Remove buf beta registry {plugin,template} {deprecate,undeprecate}.
  • Add --user and --netrc flags to buf curl, providing the same behavior as the flags of the same name in the cURL tool.
  • Include DocumentationPath in the module on buf push.
  • Support fallback paths, README.md and README.markdown, for module documentation. The default source for module documentation is buf.md. If buf.md is missing, README.md or README.markdown is used as fallback sources.

v1.17.0 - 2023-04-05

  • Fix issue with JSON marshalling of errors where line and column fields were omitted when line and column information was empty.
  • Fix issue with MSVS marshalling of errors where the column could be 0.
  • Add buf beta stats command to print statistics about a given source or module.
  • Update buf beta price with the latest pricing information.

v1.16.0 - 2023-03-29

  • Add buf beta price command to help users of the BSR figure out how much a module will cost to store on the BSR under the Teams or Pro plans.
  • Fix issue in protoc-gen-buf-lint that prevented it from reporting lint errors for unused imports.
  • Fix issue with buf format where indents would be produced on certain empty lines.
  • Remove buf alpha registry token create command. Tokens must be created through the BSR UI.
  • Add local WASM plugin support in alpha, gated by the BUF_ALPHA_ENABLE_WASM environment variable. This feature is under evaluation, and may change at any time. If you are interested in WASM Protobuf plugins, reach out to us.

v1.15.1 - 2023-03-08

  • Fix bug in buf generate with v1beta1 config files.
  • Fix potential crash when using the --type flag with buf build or buf generate.

v1.15.0 - 2023-02-28

  • Update built-in Well-Known Types to Protobuf v22.0.
  • Fix bug in buf format where C-style block comments in which every line includes a prefix (usually "*") would be incorrectly indented.
  • Add --private-network flag to buf beta studio-agent to support handling CORS requests from Studio on private networks that set the Access-Control-Request-Private-Network header.

v1.14.0 - 2023-02-09

  • Replace buf generate --include-types with buf generate --type for consistency. --include-types is now deprecated but continues to work, consistent with our compatibility guarantee.
  • Include type references in google.protobuf.Any messages in option values when filtering on type, e.g. with buf build --type or buf generate --type.
  • Allow specifying a specific protoc path in buf.gen.yaml when using protoc's built-in plugins via the new protoc_path option.
  • Allow specifying arguments for local plugins in buf.gen.yaml. You can now do e.g. path: ["go, "run", ./cmd/protoc-gen-foo] in addition to path: protoc-gen-foo.
  • Add optional name parameter to buf mod init, e.g. buf mod init buf.build/owner/foobar.
  • Fix issue with php_metadata_namespace file option in managed mode.
  • Make all help documentation much clearer. If you notice any inconsistencies, let us know.

v1.13.1 - 2023-01-27

  • Fix race condition with buf generate when remote plugins from multiple BSR instances are being used at once.

v1.13.0 - 2023-01-26

  • Extend the BUF_TOKEN environment variable to accept tokens for multiple BSR instances. Both TOKEN and TOKEN1@BSRHOSTNAME1,TOKEN2@BSRHOSTNAME2,... are now valid values for BUF_TOKEN.
  • Remove buf beta convert in favor of the now-stable buf convert.

v1.12.0 - 2023-01-12

  • Add buf curl command to invoke RPCs via Connect, gRPC, or gRPC-Web
  • Introduce objc_class_prefix option in managed mode, allowing a default value for objc_class_prefix for all files, except and override, which both behave similarly to other except and override options. Specifying an empty default value is equivalent to having managed mode on in previous versions.
  • Introduce ruby_package option in managed mode, allowing except and override, in the same style as objc_class_prefix. Leaving ruby_package unspecified has the same effect as having mananged mode enabled in previous versions.

v1.11.0 - 2022-12-19

  • buf generate now batches remote plugin generation calls for improved performance.
  • Update optimize_for option in managed mode, allowing a default value for optimize_for for all files, except and override, which both behave similarly to other except and override options. Specifying an optimize_for value in the earlier versions is equivalent to having a optimize_for with that value as default.

v1.10.0 - 2022-12-07

  • When using managed mode, setting enabled: false now no longer fails buf generate and instead prints a warning log and ignores managed mode options.
  • Add csharp_namespace option to managed mode, allowing except, which excludes modules from managed mode, and override, which specifies csharp_namespace values per module, overriding the default value. By default, when managed mode is enabled, csharp_namespace is set to the package name with each package sub-name capitalized.
  • Promote buf convert to stable, keep buf beta convert aliased in the beta command.
  • Add Types filter to buf generate command to specify types (message, enum, service) that should be included in the image. When specified, the resulting image will only include descriptors to describe the requested types.

v1.9.0 - 2022-10-19

  • New compiler that is faster and uses less memory than the outgoing one.

    • When generating source code info, the new compiler is 20% faster, and allocates 13% less memory.
    • If not generating source code info, the new compiler is 50% faster and allocates 35% less memory.
    • In addition to allocating less memory through the course of a compilation, the new compiler releases some memory much earlier, allowing it to be garbage collected much sooner. This means that by the end of a very large compilation process, less than half as much memory is live/pinned to the heap, decreasing overall memory pressure.

    The new compiler also addresses a few bugs where Buf would accept proto sources that protoc would reject:

    • In proto3 files, field and enum names undergo a validation that they are sufficiently different so that there will be no conflicts in JSON names.
    • Fully-qualified names of elements (like a message, enum, or service) may not conflict with package names.
    • A oneof or extend block may not contain empty statements.
    • Package names may not be >= 512 characters in length or contain > 100 dots.
    • Nesting depth of messages may not be > 32.
    • Field types and method input/output types may not refer to synthetic map entry messages.

  • Push lint and breaking configuration to the registry.

  • Include LICENSE file in the module on buf push.

  • Formatter better edits/preserves whitespace around inline comments.

  • Formatter correctly indents multi-line block (C-style) comments.

  • Formatter now indents trailing comments at the end of an indented block body (including contents of message and array literals and elements in compact options) the same as the rest of the body (instead of out one level, like the closing punctuation).

  • Formatter uses a compact, single-line representation for array and message literals in option values that are sufficiently simple (single scalar element or field).

  • buf beta convert flags have changed from --input to --from and --output/-o to --to

  • fully qualified type names now must be parsed to the input argument and --type flag separately

v1.8.0 - 2022-09-14

  • Change default for --origin flag of buf beta studio-agent to https://studio.buf.build
  • Change default for --timeout flag of buf beta studio-agent to 0 (no timeout). Before it was 2m (the default for all the other buf commands).
  • Add support for experimental code generation with the plugin: key in buf.gen.yaml.
  • Preserve single quotes with buf format.
  • Support junit format errors with --error-format.

v1.7.0 - 2022-06-27

  • Support protocol and encoding client options based on content-type in Studio Agent.
  • Add --draft flag to buf push.
  • Add buf beta registry draft {list,delete} commands.

v1.6.0 - 2022-06-21

  • Fix issue where // buf:lint:ignore comment ignores did not work for the ENUM_FIRST_VALUE_ZERO rule.
  • Add buf beta studio-agent command to support the upcoming Buf Studio.

v1.5.0 - 2022-05-30

  • Upgrade to protoc 3.20.1 support.
  • Fix an issue where buf would fail if two or more roots contained a file with the same name, but with different file types (i.e. a regular file vs. a directory).
  • Fix check for PACKAGE_SERVICE_NO_DELETE to detect deleted services.
  • Remove buf beta registry track.
  • Remove buf beta registry branch.

v1.4.0 - 2022-04-21

  • Fix issue where duplicate synthetic oneofs (such as with proto3 maps or optional fields) did not result in a properly formed error.
  • Add buf beta registry repository update command which supports updating repository visibility (public vs private). As with all beta commands, this is likely to change in the future.

v1.3.1 - 2022-03-30

  • Allow --config flag to be set when targeting a module within a workspace.
  • Update buf format's file option order so that default file options are sorted before custom options.
  • Update buf format to write adjacent string literals across multiple lines.
  • Fix buf format so that the output directory (if any) is created if and only if the input is successfully formatted.

v1.3.0 - 2022-03-25

  • Add --exit-code flag to buf format to exit with a non-zero exit code if the files were not already formatted.

v1.2.1 - 2022-03-24

  • Fix a few formatting edge cases.

v1.2.0 - 2022-03-24

  • Add buf format command to format .proto files.
  • Fix build scripts to avoid using the command-line-arguments pseudo-package when building binaries and re-introduce checking for proper usage of private packages.

v1.1.1 - 2022-03-21

  • Remove check for proper usage of private packages due to a breaking change made in the Golang standard library in 1.18.

v1.1.0 - 2022-03-01

  • Add --type flag to the build command to create filtered images containing only the specified types and their required dependencies.
  • Trim spaces and new lines from user-supplied token for buf registry login.
  • Add support for conversion between JSON and binary serialized message for buf beta convert.

v1.0.0 - 2022-02-17

  • Check that the user provided a valid token when running buf registry login.
  • Add buf mod open that opens a module's homepage in a browser.
  • Add buf completion command to generate auto-completion scripts in commonly used shells.
  • Add --disable-symlinks flag to the breaking, build, export, generate, lint, ls-files, push commands. By default, the CLI will follow symlinks except on Windows, and this disables following symlinks.
  • Add --include-wkt flag to buf generate. When this flag is specified alongside --include-imports, this will result in the Well-Known Types being generated as well. Most language runtimes have the Well-Known Types included as part of the core library, making generating the Well-Known Types separately undesirable.
  • Remove buf protoc. This was a pre-v1.0 demonstration to show that buf compilation produces equivalent results to mainline protoc, however buf is working on building a better Protobuf future that provides easier mechanics than our former protoc-based world. buf protoc itself added no benefit over mainline protoc beyond being considerably faster and allowing parallel compilation. If protoc is required, move back to mainline protoc until you can upgrade to buf. See #915 for more details.
  • Context modifier no longer overrides an existing token on the context. This allows buf registry login to properly check the user provided token without the token being overridden by the CLI interceptor.
  • Removed the buf config init command in favor of buf mod init.
  • Removed the buf config ls-breaking-rules command in favor of buf mod ls-breaking-rules.
  • Removed the buf config ls-lint-rules command in favor of buf mod ls-lint-rules.
  • Removed the buf config migrate-v1beta1 command in favor of buf beta migrate-v1beta1.
  • Add buf beta decode command to decode message with provided image source and message type.
  • Disable --config flag for workspaces.
  • Move default config version from v1beta1 to v1.

v1.0.0-rc12 - 2022-02-01

  • Add default, except and override to java_package_prefix.
  • Add dependency commits as a part of the b3 digest.
  • Upgrade to protoc 3.19.4 support.
  • Remove branch field from buf.lock.

v1.0.0-rc11 - 2022-01-18

  • Upgrade to protoc 3.19.3 support.
  • Add PACKAGE_NO_IMPORT_CYCLE lint rule to detect package import cycles.
  • Add buf beta registry {plugin,template} {deprecate,undeprecate}.
  • Add warning when using enterprise dependencies without specifying a enterprise remote in the module's identity.
  • Remove digest, and created_at fields from the buf.lock. This will temporarily create a new commit when pushing the same contents to an existing repository, since the ModulePin has been reduced down.
  • Add --track flag to buf push
  • Update buf beta registry commit list to allow a track to be specified.
  • Add buf beta registry track {list,delete} commands.
  • Add manpages for buf.

v1.0.0-rc10 - 2021-12-16

  • Fix issue where remote references were not correctly cached.

v1.0.0-rc9 - 2021-12-15

  • Always set compiler_version parameter in the CodeGeneratorRequest to "(unknown)".
  • Fix issue where buf mod update was unable to resolve dependencies from different remotes.
  • Display the user-provided Buf Schema Registry remote, if specified, instead of the default within the buf login message.
  • Fix issue where buf generate fails when the same plugin was specified more than once in a single invocation.
  • Update the digest algorithm so that it encodes the name, lint, and breaking configuration encoded in the buf.yaml. When this change is deployed, users will observe the following:
    • Users on v0.43.0 or before will notice mismatched digest errors similar to the one described in https://github.com/alis-exchange/buf/issues/661.
    • Users on v0.44.0 or after will have their module cache invalidated, but it will repair itself automatically.
    • The buf.lock (across all versions) will reflect the new b3- digest values for new commits.

v1.0.0-rc8 - 2021-11-10

  • Add new endpoints to the recommendation service to make it configurable.
  • Add --exclude-path flag to buf breaking, buf build, buf export, buf generate, and buf lint commands. This allows users to exclude specific paths when running commands.
  • Change GetModulePackages endpoint to return a repeated ModulePackage message that now includes package description with the package name.
  • Add Oneof to the Message structure for documentation.

v1.0.0-rc7 - 2021-11-08

  • Upgrade to protoc 3.19.1 support.
  • Fix issue with buf generate where multiple insertion points are defined in the same file.

v1.0.0-rc6 - 2021-10-20

  • Fix issue with buf ls-files when given an image as an input, imports were being printed, even without the --include-imports flag.
  • Add the ability for users to provide individual protobuf files as inputs to CLI commands. This allows users to run buf commands against and file input based on their current working directory, for example, buf lint foo/bar.proto, where foo/bar.proto is a path to protobuf file on disk.

v1.0.0-rc5 - 2021-10-12

  • Add buf beta registry repository deprecate and buf beta registry repository undeprecate.
  • Support --include-imports for remote plugins.
  • Fix issue where buf config migrate-v1beta1 fails when files cannot be renamed.
  • Fix issue where buf registry login panics when an existing .netrc entry exists.

v1.0.0-rc4 - 2021-10-07

  • Fix issue where buf generate could fail when used with large numbers of plugins and files on systems with low file limits.
  • Add buf protoc --version flag back. This was accidentally removed.
  • Upgrade to protoc 3.18.1 support.

v1.0.0-rc3 - 2021-10-04

  • Add --as-import-paths flag to ls-files that strips local directory paths and prints file paths as they are imported.
  • Fix issue where groups used in custom options did not result in the same behavior as protoc.
  • Fix issue where insertion points were not applied with respect to the configured output directory.

v1.0.0-rc2 - 2021-09-23

  • Add --include-imports flag to ls-files.
  • Upgrade to protoc 3.18.0 support.
  • Fix regression with git inputs using recurse_submodules=true.

v1.0.0-rc1 - 2021-09-15

This is our first v1.0 release candidate. This release largely concentrates on erroring for already-deprecated commands and flags.

At Buf, we take compatibility very seriously. When we say v1.0, we mean it - we hope buf will be stable on v1 for the next decade, and if there is something we want to change, it is our responsibility to make sure that we don't break you, not your responsibility to change because of us. We have learned a lot about buf usage in the last two years of our beta, and have deprecated flags and commands as we go, but for v1.0, we are removing the deprecated items to make sure we have a clean setup going forward.

All commands and flags have been printing warnings for a long time, and have an easy migration path. Simply update the command or flag, and you'll be good to go:

  • Removed the buf login command in favor of buf registry login.
  • Removed the buf logout command in favor of buf registry logout.
  • Removed the buf mod init command in favor of buf config init.
  • Removed the --name and --dep flags in buf config init.
  • Removed the --log-level global flag.
  • Moved the output of --version from stderr to stdout.
  • Moved the output of --help and help from stderr to stdout.
  • From v0.55.0: The version key in all configuration files (buf.yaml, buf.gen.yaml, buf.work.yaml) is now required.
  • From v0.45.0: Removed the buf beta config init command in favor of buf config init.
  • From v0.45.0: Removed the buf beta mod export command in favor of buf export.
  • From v0.45.0: Removed the buf beta mod init command in favor of buf config init.
  • From v0.45.0: Removed the buf beta mod update command in favor of buf mod update.
  • From v0.45.0: Removed the buf beta mod clear-cache command in favor of buf mod clear-cache.
  • From v0.45.0: Removed the buf beta push command in favor of buf push.
  • From v0.34.0: Removed the buf check breaking command in favor of buf breaking.
  • From v0.34.0: Removed the buf check lint command in favor of buf lint.
  • From v0.34.0: Removed the buf check ls-lint-checkers command in favor of buf config ls-lint-rules.
  • From v0.34.0: Removed the buf check ls-breaking-checkers command in favor of buf config ls-breaking-rules.
  • From v0.31.0: Removed the --file flag on buf build in favor of the --path flag.
  • From v0.31.0: Removed the --file flag on buf lint in favor of the --path flag.
  • From v0.31.0: Removed the --file flag on buf breaking in favor of the --path flag.
  • From v0.31.0: Removed the --file flag on buf generate in favor of the --path flag.
  • From v0.31.0: Removed the --file flag on buf export in favor of the --path flag.
  • From v0.29.0: Removed the --source flag on buf build in favor of the first positional parameter.
  • From v0.29.0: Removed the --source-config flag on buf build in favor of the --config flag.
  • From v0.29.0: Removed the --input flag on buf lint in favor of the first positional parameter.
  • From v0.29.0: Removed the --input-config flag on buf lint in favor of the --config flag.
  • From v0.29.0: Removed the --input flag on buf breaking in favor of the first positional parameter.
  • From v0.29.0: Removed the --input-config flag on buf breaking in favor of the --config flag.
  • From v0.29.0: Removed the --against-input flag on buf breaking in favor of the --against flag.
  • From v0.29.0: Removed the --against-input-config flag on buf breaking in favor of the --against-config flag.
  • From v0.29.0: Removed the --input flag on buf generate in favor of the first positional parameter.
  • From v0.29.0: Removed the --input-config flag on buf generate in favor of the --config flag.
  • From v0.29.0: Removed the --input flag on buf ls-files in favor of the first positional parameter.
  • From v0.29.0: Removed the --input-config flag on buf ls-files in favor of the --config flag.
  • From v0.29.0: Removed the buf image build command in favor of buf build.
  • From v0.29.0: Removed the buf image convert command.
  • From v0.29.0: Removed the buf beta image convert command.
  • From v0.23.0: Removed the buf experimental image convert command.
  • From v0.52.0 and v0.34.0: Complete deletion protoc-gen-buf-check-breaking and protoc-gen-buf-check-lint, which have been moved to protoc-gen-buf-breaking and protoc-gen-buf-lint.

In January 2021 (v0.34.0), protoc-gen-buf-check-breaking and protoc-gen-buf-check-lint were deprecated and scheduled for removal for v1.0. In August 2021 (v0.52.0), we began returning error for every invocation of protoc-gen-buf-check-breaking and protoc-gen-buf-check-lint. This release completes the deletion process.

The only migration necessary is to change your installation and invocation from protoc-gen-buf-check-breaking to protoc-gen-buf-breaking and protoc-gen-buf-check-lint to protoc-gen-buf-lint. These can be installed in the exact same manner, whether from GitHub Releases, Homebrew, AUR, or direct Go installation:

# instead of go get github.com/alis-exchange/buf/cmd/protoc-gen-buf-check-breaking
go get github.com/alis-exchange/buf/cmd/protoc-gen-buf-breaking
# instead of curl -sSL https://github.com/alis-exchange/buf/releases/download/v0.57.0/protoc-gen-buf-check-breaking-Linux-x86_64
curl -sSL https://github.com/alis-exchange/buf/releases/download/v0.57.0/protoc-gen-buf-breaking-Linux-x86_64

v0.56.0 - 2021-09-08

  • Cascade ENUM_ZERO_VALUE_SUFFIX comment ignores from the enum level.
  • Fix issue where buf genarate --output was not being respected in 0.55.0.

v0.55.0 - 2021-09-07

  • Error if version: is not set in buf.yaml. This is one of the few breaking changes we must make before v1.0 to guarantee stability for the future. If you do not have a version set, simply add version: v1beta1 to the top of your buf.yaml.
  • Support BUF_TOKEN for authentication. buf will now look for a token in the BUF_TOKEN environment variable, falling back to .netrc as set via buf login.
  • Add support for using remote plugins with local source files.
  • Add per-file overrides for managed mode.
  • Fix issue with the module cache where multiple simulataneous downloads would result in a temporarily-corrupted cache.
  • Hide verbose messaing behind the --verbose (-v) flag.
  • Add --debug flag to print out debug logging.

v0.54.1 - 2021-08-30

  • Fix docker build.

v0.54.0 - 2021-08-30

  • Add windows support.
  • Add java_package_prefix support to managed mode.
  • Fix issue with C# namespaces in managed mode.
  • Fix issue where :main was appended for errors containing references to modules.

v0.53.0 - 2021-08-25

  • Fix issue where buf generate --include-imports would end up generating files for certain imports twice.
  • Error when both a buf.mod and buf.yaml are present. buf.mod was briefly used as the new default name for buf.yaml, but we've reverted back to buf.yaml.

v0.52.0 - 2021-08-19

Return error for all invocations of protoc-gen-buf-check-breaking and protoc-gen-buf-check-lint.

As one of the few changes buf will ever make, protoc-gen-buf-check-breaking and protoc-gen-buf-check-lint were deprecated and scheduled for removal for v1.0 in January 2021. In preparation for v1.0, instead of just printing out a message notifying users of this, these commands now return an error for every invocation and will be completely removed when v1.0 is released.

The only migration necessary is to change your installation and invocation from protoc-gen-buf-check-breaking to protoc-gen-buf-breaking and protoc-gen-buf-check-lint to protoc-gen-buf-lint. These can be installed in the exact same manner, whether from GitHub Releases, Homebrew, AUR, or direct Go installation:

# instead of go get github.com/alis-exchange/buf/cmd/protoc-gen-buf-check-breaking
go get github.com/alis-exchange/buf/cmd/protoc-gen-buf-breaking
# instead of curl -sSL https://github.com/alis-exchange/buf/releases/download/v0.52.0/protoc-gen-buf-check-breaking-Linux-x86_64
curl -sSL https://github.com/alis-exchange/buf/releases/download/v0.52.0/protoc-gen-buf-breaking-Linux-x86_64

There is no change in functionality.

v0.51.1 - 2021-08-16

  • Fix issue with git LFS where a remote must be set for fetch.

v0.51.0 - 2021-08-13

  • Accept packages of the form v\d+alpha and v\d+beta as packages with valid versions. These will be considered unstable packages for the purposes of linting and breaking change detection if ignore_unstable_packages is set.
  • Fix issue with git clones that occurred when using a previous reference of the current branch.

v0.50.0 - 2021-08-12

  • Add buf generate --include-imports that also generates all imports except for the Well-Known Types.
  • Fix issue where a deleted file within an unstable package that contained messages, enums, or services resulted in a breaking change failure if the PACKAGE category was used and ignore_unstable_packages was set.

v0.49.0 - 2021-08-10

  • Split FIELD_SAME_TYPE breaking change rule into FIELD_SAME_TYPE, FIELD_WIRE_COMPATIBLE_TYPE, FIELD_WIRE_JSON_COMPATIBLE_TYPE in v1. See https://github.com/alis-exchange/buf/pull/400 for details.
  • Only export imported dependencies from buf export.

v0.48.2 - 2021-07-30

  • Fix git args for http auth with git lfs.

v0.48.1 - 2021-07-30

  • Fix: use -c on git parent command instead of --config on git fetch.
  • Add ruby_package to managed mode.

v0.48.0 - 2021-07-29

  • Add buf export. buf export will export the files from the specified input (default ".") to the given directory in a manner that is buildable by protoc without any -I flags. It also has options --exclude-imports, which excludes imports (and won't result in a buildable set of files), and --path, which filters to the specific paths.

v0.47.0 - 2021-07-29

  • Rewrite the git cloner to use git init && git fetch rather than git clone. git clone is limited to local branches on the remote, whereas git fetch we can fetch any references on the remote including remote branches.
  • Add php_namespace managed mode handling.
  • Add java_string_check_utf8 managed mode handling.

v0.46.0 - 2021-07-27

  • Add buf login and buf logout to login and logout from the Buf Schema Registry.
  • Fix cache, configuration, and data environment variables for Windows. Note that while Windows is still not officially supported, buf largely works on Windows.

v0.45.0 - 2021-07-26

  • Revert default configuration file location back from buf.mod to buf.yaml. Note that both continue to work.
  • Move default workspace configuration file location from buf.work to buf.work.yaml. Note that both continue to work.
  • Move buf beta push to buf push. Note that buf beta push continues to work.
  • Move most buf beta mod commands to buf mod. Note that all buf beta mod commands continue to work.
  • Add --only flag to buf mod update.
  • Warn if buf.yaml contains dependencies that are not represented in the buf.lock file.
  • Add --version flag to buf config ls-{breaking,lint}-rules.
  • Add SYNTAX_SPECIFIED lint rule to BASIC, DEFAULT categories for v1 configuration.
  • Add IMPORT_USED lint rule to BASIC, DEFAULT categories for v1 configuration.
  • Bring v1 configuration out of beta.
  • Add managed mode for objc_class_prefix, csharp_namespace.

v0.44.0 - 2021-07-08

  • Fix issue where C++ scoping rules were not properly enforced.
  • Add support for splitting directory paths passed to buf protoc -I by a directory separator.
  • Fix Windows support for builtin protoc plugins when using buf generate or buf protoc. Note that Windows remains officially unsupported as we have not set up testing, but largely works.
  • Upgrade to protoc 3.17.3 support.
  • Change the default module configuration location from buf.yaml to buf.mod. Note that buf.yaml continues to work.
  • Continued work on the workspaces beta, including the v1 configuration specification.
  • Continued work on the managed mode beta, including the v1 configuration specification.
  • Add v1 module configuration specification in beta - please continue to use v1beta1 until the v1 configuration specification is rolled out.
  • Add buf config migrate-v1beta1.

v0.43.2 - 2021-05-31

  • Fix namespace resolution diff with protoc.

v0.43.1 - 2021-05-28

  • Revert protoc namespace resolution diff change.

v0.43.0 - 2021-05-28

  • Do not count buf:lint:ignore directives as valid comments for the COMMENT_.* lint rules.
  • Upgrade to protoc 3.17.1 support.
  • Fix namespace resolution diff with protoc.

v0.42.1 - 2021-05-20

  • Change the architecture suffix of the Linux ARM release assets from arm64 to aarch64 to match the output of uname -m on Linux.

v0.42.0 - 2021-05-20

  • Add managed mode in beta. This is a new feature that automatically sets file option values.
  • Add workspaces in beta. This is a new feature that allows multiple modules within the same directory structure.
  • Add arm64 releases.

v0.41.0 - 2021-04-01

  • Add MESSAGE_SAME_REQUIRED_FIELDS breaking change rule. This checks to make sure no required fields are added or deleted from existing messages.
  • Support multi-architecture Docker image.
  • Exit with code 100 for FileAnnotation errors.

v0.40.0 - 2021-03-15

  • Add buf beta registry tag {create,list} commands.
  • Add support for creating tags in push via buf beta push -t.
  • Fix an issue where errors were unnecessarily written in buf lint and buf breaking.

v0.39.1 - 2021-03-04

  • Fix issue with CLI build process in 0.39.0.

v0.39.0 - 2021-03-04

  • buf beta push doesn't create a new commit if the content of the push is the same as the latest commit on the branch.
  • Fix an issue where no error was shown when authentication failed.
  • Fix an issue where buf protoc would error if a plugin returned an empty error string.

v0.38.0 - 2021-02-25

  • Update the tested protoc version for compatibility to 3.15.2. The --experimental_allow_proto3_optional flag is no longer set for versions >=3.15.
  • Update the Well-Known Types to 3.15.2. The go_package values for the Well-Known Types now point at google.golang.org/protobuf instead of github.com/golang/protobuf.

v0.37.1 - 2021-02-23

  • Fix bug where authentication headers were not threaded through for certain Buf Schema Registry commands.
  • Fix issue where empty errors would incorrectly be wrapped by the CLI interceptor.
  • Update Buf module cache location to include remote.

v0.37.0 - 2021-02-09

  • Add commands for the Buf Schema Registry. Visit our website to add yourself to the waitlist.

v0.36.0 - 2021-01-18

Allows comment ignores of the form // buf:lint:ignore ID to be cascaded upwards for specific rules.

  • For ENUM_VALUE_PREFIX, ENUM_VALUE_UPPER_SNAKE_CASE, both the enum value and the enum are checked.
  • For FIELD_LOWER_SNAKE_CASE, FIELD_NO_DESCRIPTOR, both the field and message are checked.
  • For ONEOF_LOWER_SNAKE_CASE, both the oneof and message are checked.
  • For RPC_NO_CLIENT_STREAMING, RPC_NO_SERVER_STREAMING, RPC_PASCAL_CASE, RPC_REQUEST_RESPONSE_UNIQUE, both the method and service are checked.
  • For RPC_REQUEST_STANDARD_NAME, RPC_RESPONSE_STANDARD_NAME, the input/output type, method, and service are checked.

v0.35.1 - 2021-01-08

  • Fix error when unmarshalling plugin configuration with no options (#236)

v0.35.0 - 2021-01-07

  • Allow opt in buf.gen.yaml files to be either a single string, or a list of strings. Both of the following forms are accepted, and result in foo=bar,baz,bat:
version: v1beta1
plugins:
  - name: foo
    out: out
    opt: foo=bar,baz,bat
version: v1beta1
plugins:
  - name: foo
    out: out
    opt:
      - foo=bar
      - baz
      - bat

v0.34.0 - 2021-01-04

  • Move buf check lint to buf lint.
  • Move buf check breaking to buf breaking.
  • Move buf check ls-lint-checkers to buf config ls-lint-rules.
  • Move buf check ls-breaking-checkers to buf config ls-breaking-rules.
  • Move protoc-gen-buf-check-lint to protoc-gen-buf-lint.
  • Move protoc-gen-buf-check-breaking to protoc-gen-buf-breaking.
  • Add buf beta config init.

All previous commands continue to work in a backwards-compatible manner, and the previous protoc-gen-buf-check-lint and protoc-gen-buf-check-breaking binaries continue to be available at the same paths, however deprecation messages are printed.

v0.33.0 - 2020-12-12

  • Add strategy option to buf.gen.yaml generation configuration. This allows selecting either plugin invocations with files on a per-directory basis, or plugin invocations with all files at once. See the generation documentation for more details.

v0.32.1 - 2020-12-10

  • Fix issue where SourceCodeInfo for map fields within nested messages could be dropped.
  • Fix issue where deleted files would cause a panic when breaking.ignore_unstable_packages = true.

v0.32.0 - 2020-11-24

  • Add symlink support for directory inputs. Symlinks will now be followed within your local directories when running buf commands.
  • Add the breaking.ignore_unstable_packages option to allow ignoring of unstable packages when running buf check breaking. See the documentation for more details.
  • Enums that use the allow_alias option that add new aliases to a given number will no longer be considered breaking by ENUM_VALUE_SAME_NAME. See the documentation for more details.

v0.31.1 - 2020-11-17

  • Fix issue where --experimental_allow_proto3_optional was not set when proxying to protoc for the builtin plugins via buf generate or buf protoc. This flag is now set for protoc versions >= 3.12.

v0.31.0 - 2020-11-16

  • Change the --file flag to --path and allow --path to take both files and directories, instead of just files with the old --file. This flag is used to filter the actual Protobuf files built under an input for most commands. You can now do for example buf generate --path proto/foo to only generate stubs for the files under proto/foo. Note that the --file flag continues to work, but prints a deprecation message.

v0.30.1 - 2020-11-12

  • Relax validation of response file names from protoc plugins, so that when possible, plugins that are not compliant with the plugin specification are still usable with buf generate.

v0.30.0 - 2020-11-03

  • Add git:// protocol handling.

v0.29.0 - 2020-10-30

As we work towards v1.0, we are cleaning up the CLI UX. As part of this, we made the following changes:

  • buf image build has been moved to buf build and now accepts images as inputs.
  • buf beta image convert has been deleted, as buf build now covers this functionality.
  • The -o flag is no longer required for buf build, instead defaulting to the OS equivalent of /dev/null.
  • The --source flag on buf build has been deprecated in favor of passing the input as the first argument.
  • The --source-config flag on buf build has been moved to --config.
  • The --input flag on buf check lint has been deprecated in favor of passing the input as the first argument.
  • The --input-config flag on buf check lint has been moved to --config.
  • The --input flag on buf check breaking has been deprecated in favor of passing the input as the first argument.
  • The --input-config flag on buf check breaking has been moved to --config.
  • The --against-input flag on buf check breaking has been moved to --against.
  • The --against-input-config flag on buf check breaking has been moved to --against-config.
  • The --input flag on buf generate has been deprecated in favor of passing the input as the first argument.
  • The --input-config flag on buf generate has been moved to --config.
  • The --input flag on buf ls-files has been deprecated in favor of passing the input as the first argument.
  • The --input-config flag on buf ls-files has been moved to --config.

We feel these changes make using buf more natural. Examples:

# compile the files in the current directory
buf build
# equivalent to the default no-arg invocation
buf build .
# build the repository at https://github.com/foo/bar.git
buf build https://github.com/foo/bar.git
# lint the files in the proto directory
buf check lint proto
# check the files in the current directory against the files on the master branch for breaking changes
buf check breaking --against .git#branch=master
# check the files in the proto directory against the files in the proto directory on the master branch
buf check breaking proto --against .git#branch=master,subdir=proto

Note that existing commands and flags continue to work. While the deprecation messages will be printed, and we recommend migrating to the new invocations, your existing invocations have no change in functionality.

v0.28.0 - 2020-10-21

  • Add subdir option for archive and git Inputs. This allows placement of the buf.yaml configuration file in directories other than the base of your repository. You then can check against this subdirectory using, for example, buf check breaking --against-input https://github.com/foo/bar.git#subdir=proto.

v0.27.1 - 2020-10-16

  • Fix minor typo in buf help generate documentation.

v0.27.0 - 2020-10-16

  • Move buf beta generate out of beta to buf generate. This command now uses a template of configured plugins to generate stubs. See buf help generate for more details.

v0.26.0 - 2020-10-13

  • Add jar and zip support to buf protoc and buf beta generate.

v0.25.0 - 2020-10-09

  • Add the concept of configuration file version. The only currently-available version is v1beta1. See buf.build/docs/faq for more details.

v0.24.0 - 2020-09-21

  • Add fish completion to releases.
  • Update the protoc version for buf protoc to be 3.13.0.

v0.23.0 - 2020-09-11

  • Move the experimental parent command to beta. The command buf experimental image convert continues to work, but is deprecated in favor of buf beta image convert.
  • Add buf beta generate.

v0.22.0 - 2020-09-09

v0.21.0 - 2020-09-02

  • Fix issue where optional fields in proto3 would cause the ONEOF_LOWER_SNAKE_CASE lint checker to fail.

v0.20.5 - 2020-07-24

v0.20.4 - 2020-07-21

  • Fix issue where custom message options that had an unset map field could cause a parser failure.

v0.20.3 - 2020-07-18

  • Fix issue where parameters passed with --.*_opt to buf protoc for builtin plugins were not properly propagated.

v0.20.2 - 2020-07-17

  • Fix issue where roots containing non-proto files with the same path would cause an error.

v0.20.1 - 2020-07-14

  • Fix issue where Zsh completion would fail due to some flags having brackets in their description.
  • Fix issue where non-builtin protoc plugin invocations would not have errors properly propagated.
  • Fix issue where multiple --.*_opt flags, --.*_opt flags with commas, or --.*_out flags with options that contained commas, would not be properly added.

v0.20.0 - 2020-07-13

  • Add --by-dir flag to buf protoc that parallelizes generation per directory, resulting in a 25-75% reduction in the time taken to generate stubs for medium to large file sets.
  • Properly clean up temporary files and commands on interrupts.
  • Fix issue where certain files that started with invalid Protobuf would cause the parser to crash.

v0.19.1 - 2020-07-10

  • Fix issue where stderr was not being propagated for protoc plugins in CLI mode.

v0.19.0 - 2020-07-10

  • Add protoc command. This is a substitute for protoc that uses Buf's internal compiler.
  • Add ENUM_FIRST_VALUE_ZERO lint checker to the OTHER category.
  • Add support for the Visual Studio error format.

v0.18.1 - 2020-06-25

  • Fix issue where linking errors for custom options that had a message type were not properly reported (#93)

v0.18.0 - 2020-06-22

  • Handle custom options when marshalling JSON images (#87).
  • Add buf experimental image convert command to convert to/from binary/JSON images (#87).

v0.17.0 - 2020-06-17

  • Add git ref support to allow specifying arbitrary git references as inputs (https://github.com/alis-exchange/buf/issues/48). This allows you to do i.e. buf check lint --input https://github.com/alis-exchange/buf.git#ref=fa74aa9c4161304dfa83db4abc4a0effe886d253.
  • Add depth input option when specifying git inputs with ref. This allows the user to configure the depth at which to clone the repository when looking for the ref. If specifying a ref, this defaults to 50. Otherwise, this defaults to 1.
  • Remove requirement for git branch or tag in inputs. This allows you to do i.e. buf check lint --input https://github.com/alis-exchange/buf.git and it will automatically choose the default branch as an input.

v0.16.0 - 2020-06-02

v0.15.0 - 2020-05-31

  • Add opt-in comment-driven lint ignores via the allow_comment_ignores lint configuration option and buf:lint:ignore ID leading comment annotation (#73).

v0.14.0 - 2020-05-30

  • Add --file flag to buf image build to only add specific files and their imports to outputted images. To exclude imports, use --exclude-imports.
  • Add zip as a source format. Buf can now read zip files, either locally or remotely, for image building, linting, and breaking change detection.
  • Add zstd as a compression format. Buf can now read and write Image files that are compressed using zstandard, and can read tarballs compressed with zstandard.
  • Deprecated: The formats bingz, jsongz, targz are now deprecated. Instead, use format=bin,compression=gzip, format=json,compression=gzip, or format=tar,compression=gzip. The formats bingz, jsongz, targz will continue to work forever and will not be broken, but will print a deprecation warning and we recommend updating. Automatic file extension parsing continues to work the same as well.

v0.13.0 - 2020-05-17

  • Use the git binary instead of go-git for internal clones. This also enables using your system git credential management for git repositories cloned using https or ssh. See https://buf.build/docs/inputs#authentication for more details.

v0.12.1 - 2020-05-11

  • Fix issue where roots were detected as overlapping if one root's name was a prefix of the other.

v0.12.0 - 2020-05-11

  • Add netrc support for inputs.
  • Fix issue where filenames that contained .. resulted in an error.
  • Internal: migrate to golang/protobuf v2.

v0.11.0 - 2020-04-09

  • Add experimental flag --experimental-git-clone to use the git binary for git clones.

v0.10.0 - 2020-04-06

  • Add recurse_submodules option for git inputs. Example: https://github.com/foo/bar.git#branch=master,recurse_submodules=true

v0.9.0 - 2020-03-25

  • Fix issue where the option value ordering on an outputted Image was non-deterministic.
  • Fix issue where the SourceCodeInfo for the Well-Known Types was not included on an outputted Image when requested.

v0.8.0 - 2020-03-11

  • Update dependencies.

v0.7.1 - 2020-03-05

  • Tie HTTP download timeout to the --timeout flag.

v0.7.0 - 2020-01-31

  • Add tag option for git inputs.

v0.6.0 - 2020-01-17

  • Add git to the Docker container for local filesystem clones.
  • Update the JSON error format to use path as the file path key instead of filename.

v0.5.0 - 2020-01-01

v0.4.1 - 2019-12-30

  • Fix issue where comparing enum values for enums that have allow_alias set and duplicate enum values present resulted in a system error.

v0.4.0 - 2019-12-05

  • Change the breaking change detector to compare enum values on number instead of name. This also results in the ENUM_VALUE_SAME_NUMBER checker being replaced with the ENUM_VALUE_SAME_NAME checker, except this new checker is not in the WIRE category.

v0.3.0 - 2019-11-05

  • Fix issue where multiple timeout errors were printed.
  • Add buf check lint --error-format=config-ignore-yaml to print out current lint errors in a format that can be copied into a configuration file.

v0.2.0 - 2019-10-28

  • Add a Docker image for the buf binary.

v0.1.0 - 2019-10-18

Initial beta release.