github.com/bufbuild/buf

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.

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

• 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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• Add git:// protocol handling.

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.

• 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.

• Fix minor typo in buf help generate documentation.

• 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.

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

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

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

• 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.

• Add insertion point support to buf protoc.

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

• Fix issue where parser would fail on files starting with byte order marks.

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

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

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

• 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.

• 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.

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

• 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.

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

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

• Add git ref support to allow specifying arbitrary git references as inputs (https://github.com/bufbuild/buf/issues/48). This allows you to do i.e. buf check lint --input https://github.com/bufbuild/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/bufbuild/buf.git and it will automatically choose the default branch as an input.

• Add proto3 optional support.

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

• 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.

• 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.

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

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

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

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

• 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.