Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking change in version 1.32 #346

Open
mx-psi opened this issue Jun 17, 2021 · 1 comment
Open

Breaking change in version 1.32 #346

mx-psi opened this issue Jun 17, 2021 · 1 comment

Comments

@mx-psi
Copy link

mx-psi commented Jun 17, 2021

Version 1.32 introduces a breaking change on PR #329, since it changes the Logger interface. Since the module is marked as stable this introduces some issues on (direct and indirect) consumers of this module because of Go minimal version selection. For example, one can't use v1.32 of the module if you have a dependency that uses v1.31 's Logger, since Go picks one and only one version to use. This is a common problem on other libraries that make breaking changes like grpc-go (see e.g. etcd-io/etcd#12124 which makes it impossible for anyone depending, directly or indirectly, on etcd v3.4 to use any grpc version higher than v1.29.0).

One possible way to prevent this in the future is to use apidiff or a similar tool on the CI. I don't have enough context to judge if the Logger change should be reverted or not, but it's a possibility to retract a version on your go.mod file if necessary.

@AlexandreYang
Copy link
Contributor

Adding some context, this breaking change has been discussed here: #329 (comment)
cc @it1804 @SuperQ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants