go.mod: add warnings about overridden versions#5208
go.mod: add warnings about overridden versions#5208thaJeztah wants to merge 1 commit intocontainerd:mainfrom
Conversation
Adding warning comments to go.mod to guide users to the actual version that is used (and tested against). In the "replace" section, adding comments that explain the reason for pinning some of the dependencies to specific versions. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| // FIXME gogo/googleapis must be v1.3.2 <BECAUSE> | ||
| github.com/gogo/googleapis => github.com/gogo/googleapis v1.3.2 |
There was a problem hiding this comment.
googleapis should be safe, it was kept because bumping will cause some pb.go changed, again IIRC 😂
There was a problem hiding this comment.
Thanks for looking! I'll wait for others to comment if they have more details, and will update the PR based on that.
| // FIXME golang/protobuf must be v1.3.5 <BECAUSE> | ||
| github.com/golang/protobuf => github.com/golang/protobuf v1.3.5 | ||
| // urfave/cli must be <= v1.22.1 due to a regression: https://github.com/urfave/cli/issues/1092 | ||
| github.com/urfave/cli => github.com/urfave/cli v1.22.1 | ||
| // FIXME genproto must be v0.0.0-20200224152610-e50cd9704f63 <BECAUSE> | ||
| google.golang.org/genproto => google.golang.org/genproto v0.0.0-20200224152610-e50cd9704f63 | ||
| // FIXME olang.org/grpc be v1.27.1 <BECAUSE> | ||
| google.golang.org/grpc => google.golang.org/grpc v1.27.1 |
There was a problem hiding this comment.
IIRC, bumping grpc will cause protobuf to be bumped, thus containerd/ttrpc#62
There was a problem hiding this comment.
Ah! Yes, I recalled there were some specific issues with grpc, but forgot which ones that were (but the motivation for me to open this PR, because it's very easy to miss for users, and (IIRC), some of the incompatibilities may not "fail hard", but only occur "sometimes", so better to have clear warnings
|
@AkihiroSuda @dmcgowan I could use some help on this one; for some of the replace rules, there's no (documented) motivation; we should check if they're still relevant (and if so, add the description) |
|
Build succeeded.
|
|
@thaJeztah: The following test failed, say
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
We should be able to remove these replace's after merging #6841 😎 |
|
Closing. We don't have replace directives anymore. |
|
Ah, yup! |
Adding warning comments to go.mod to guide users to the actual version that is used (and tested against).
In the "replace" section, adding comments that explain the reason for pinning some of the dependencies to specific versions.