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 ofbuf registry login
. - Removed the
buf logout
command in favor ofbuf registry logout
. - Removed the
buf mod init
command in favor ofbuf config init
. - Removed the
--name
and--dep
flags inbuf config init
. - Moved the output of
--version
from stderr to stdout. - Moved the output of
--help
andhelp
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 ofbuf config init
. - From v0.45.0: Removed the
buf beta mod export
command in favor ofbuf export
. - From v0.45.0: Removed the
buf beta mod init
command in favor ofbuf config init
. - From v0.45.0: Removed the
buf beta mod update
command in favor ofbuf mod update
. - From v0.45.0: Removed the
buf beta mod clear-cache
command in favor ofbuf mod clear-cache
. - From v0.45.0: Removed the
buf beta push
command in favor ofbuf push
. - From v0.34.0: Removed the
buf check breaking
command in favor ofbuf breaking
. - From v0.34.0: Removed the
buf check lint
command in favor ofbuf lint
. - From v0.34.0: Removed the
buf check ls-lint-checkers
command in favor ofbuf config ls-lint-rules
. - From v0.34.0: Removed the
buf check ls-breaking-checkers
command in favor ofbuf config ls-breaking-rules
. - From v0.31.0: Removed the
--file
flag onbuf build
in favor of the--path
flag. - From v0.31.0: Removed the
--file
flag onbuf lint
in favor of the--path
flag. - From v0.31.0: Removed the
--file
flag onbuf breaking
in favor of the--path
flag. - From v0.31.0: Removed the
--file
flag onbuf generate
in favor of the--path
flag. - From v0.31.0: Removed the
--file
flag onbuf export
in favor of the--path
flag. - From v0.29.0: Removed the
--source
flag onbuf build
in favor of the first positional parameter. - From v0.29.0: Removed the
--source-config
flag onbuf build
in favor of the--config
flag. - From v0.29.0: Removed the
--input
flag onbuf lint
in favor of the first positional parameter. - From v0.29.0: Removed the
--input-config
flag onbuf lint
in favor of the--config
flag. - From v0.29.0: Removed the
--input
flag onbuf breaking
in favor of the first positional parameter. - From v0.29.0: Removed the
--input-config
flag onbuf breaking
in favor of the--config
flag. - From v0.29.0: Removed the
--against-input
flag onbuf breaking
in favor of the--against
flag. - From v0.29.0: Removed the
--against-input-config
flag onbuf breaking
in favor of the--against-config
flag. - From v0.29.0: Removed the
--input
flag onbuf generate
in favor of the first positional parameter. - From v0.29.0: Removed the
--input-config
flag onbuf generate
in favor of the--config
flag. - From v0.29.0: Removed the
--input
flag onbuf ls-files
in favor of the first positional parameter. - From v0.29.0: Removed the
--input-config
flag onbuf ls-files
in favor of the--config
flag. - From v0.29.0: Removed the
buf image build
command in favor ofbuf 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
andprotoc-gen-buf-check-lint
, which have been moved toprotoc-gen-buf-breaking
andprotoc-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/bufbuild/buf/cmd/protoc-gen-buf-check-breaking
go get github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking
# instead of curl -sSL https://github.com/bufbuild/buf/releases/download/v0.57.0/protoc-gen-buf-check-breaking-Linux-x86_64
curl -sSL https://github.com/bufbuild/buf/releases/download/v0.57.0/protoc-gen-buf-breaking-Linux-x86_64