Minimum version selection #3617
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akutz
force-pushed
the
feature/mvs
branch
2 times, most recently
from
1f1bfdf
to
f34d089
Compare
dougm
approved these changes
Nov 8, 2024
| @@ -1,24 +1,21 @@ | |||
| module github.com/vmware/govmomi | |||
|
|
|||
| go 1.22 | |||
| go 1.21 // required for slices/maps package and built-in clear function | |||
There was a problem hiding this comment.
I had bumped to 1.22 here just because we support the latest 2 Go minor versions and only test w/ those versions.
There was a problem hiding this comment.
Hmm, how do you want to handle this? Should we consider changing this behavior to "leave version alone unless the library needs a newer version?"
There was a problem hiding this comment.
Yeah that sounds good, let's leave it alone for now
This patch updates this project's root `go.mod` file to specify the minimum required version of Go and minimum required versions for dependencies. This change ensures consumers of the GoVmomi module are not forced to use a version of Golang or dependency just because this project's root `go.mod` file specifies them. The release of Go 1.21 changed the meaning of the Go version specified in `go.mod` (https://go.dev/doc/modules/gomod-ref#go-notes): The go directive sets the minimum version of Go required to use this module. Before Go 1.21, the directive was advisory only; now it is a mandatory requirement: Go toolchains refuse to use modules declaring newer Go versions. This means if GoVmomi specified Go 1.23.2 in its `go.mod` file, any project that imported GoVmomi would also be required to use Go 1.23.2. Of course the `govc` and `vcsim` binaries still specify the latest Go version and newest dependencies to mitigate CVEs. Except for these two packages, the rest of GoVmomi is never built as a binary artifact, ex. executable / plug-in. Thus it is fine for the rest of the project to use an older Go version and older dependencies. Signed-off-by: akutz <akutz@vmware.com> BREAKING: The `go install` command may no longer be used to install govc and vcsim directly from GitHub. This is because both packages are now distinct sub-modules that still depend on the other packages in this project. Therefore these sub-mods use the following replace directive: replace github.com/vmware/govmomi -> ../ This teaches govc and vcsim where to look for the imported GoVmomi packages. This ensures that building these binaries will pick up any local changes to the rest of the project. However, the `go install` command does not support installing modules from a remote location if the module contains a `replace` directive. This means users will need to either clone all of github.com/vmware/govmomi before running `go -C govc install` or `go -C vcsim install`, or they can download the released binaries directly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This patch updates this project's root
go.modfile to specify the minimum required version of Go and minimum required versions for dependencies.This change ensures consumers of the GoVmomi module are not forced to use a version of Golang or dependency just because this project's root
go.modfile specifies them.The release of Go 1.21 changed the meaning of the Go version specified in
go.mod(https://go.dev/doc/modules/gomod-ref#go-notes):This means if GoVmomi specified Go 1.23.2 in its
go.modfile, any project that imported GoVmomi would also be required to use Go 1.23.2.Of course the
govcandvcsimbinaries still specify the latest Go version and newest dependencies to mitigate CVEs. Except for these two packages, the rest of GoVmomi is never built as a binary artifact, ex. executable / plug-in. Thus it is fine for the rest of the project to use an older Go version and older dependencies.The only downside to this change is that
govcandvcsimmay no longer be installed by running:go install github.com/vmware/govmomi/govc@latestgo install github.com/vmware/govmomi/vcsim@latestThis is because both packages are now distinct sub-modules that still depend on the other packages in this project. Therefore these sub-mods use the following replace directive:
This teaches govc and vcsim where to look for the imported GoVmomi packages. This ensures that building these binaries will pick up any local changes to the rest of the project.
However, the
go installcommand does not support installing modules from a remote location if the module contains areplacedirective. This means users will need to either clone all of github.com/vmware/govmomi before runninggo -C govc installorgo -C vcsim install, or they can download the released binaries directly.Closes:
NAHow Has This Been Tested?
Ran the following commands locally:
make installgorelease release --snapshot --cleanmake testGuidelines
Please read and follow the
CONTRIBUTIONguidelines of this project.