rgburke
Build Fails Due to Dependency Version Mismatch
Description
While rebuilding the project using the latest version of Go, with Go's official recommendation to use gomodule for initialization and building, we found that the build process fails due to mismatched module path.
The following error log was produced during the build process:
......
go: found github.com/stretchr/testify/mock in github.com/stretchr/testify v1.9.0
go: github.com/rgburke/grv/cmd/grv imports
github.com/Sirupsen/logrus: github.com/Sirupsen/[email protected]: parsing go.mod:
module declares its path as: github.com/sirupsen/logrus
but was required as: github.com/Sirupsen/logrus
Result
The build fails with errors related to mismatched module path.
The error dependency is github.com/Sirupsen/logrus.
Reason
The error log suggests module path declaration github.com/sirupsen/logrus in go.mod, which is inconsistent with import path github.com/Sirupsen/logrus .
Proposed Solution
To resolve this issue, we analyzed the project and identified the correct versions of the required dependencies.
The analysis shows that the correct declaration for the dependency is replace github.com/Sirupsen/logrus => github.com/sirupsen/logrus v1.9.2 . This version is the latest version of the dependency.
Consider adopting this suggested version to prevent other developers from encountering build failures when constructing the project.
This information can be documented in the README.md file or another relevant location.
Additional Suggestions
To ensure reproducible builds and align with the evolving trends of the Go programming language, it is recommended that the current project be migrated to the Go module mechanism.
Updating to the go module mechanism allows for managing third-party dependency versions through the go.mod file, which provides a centralized and consistent way to specify dependency constraints.
We have generated a go.mod file with the correct versions of the third-party dependencies needed for this project.
The suggested go.mod file is as follows:
replace github.com/Sirupsen/logrus => github.com/sirupsen/logrus v1.9.2
replace gopkg.in/libgit2/git2go.v27 => github.com/libgit2/git2go/v27 v27.14.7
require (
github.com/Sirupsen/logrus v0.0.0-00010101000000-000000000000
github.com/bradfitz/slice v0.0.0-20180809154707-2b758aa73013
github.com/gobwas/glob v0.2.3
github.com/google/go-github v17.0.0+incompatible
github.com/mattn/go-runewidth v0.0.16
github.com/rgburke/goncurses v0.0.0-20180201210814-74f667ab258b
github.com/rjeczalik/notify v0.9.3
github.com/stretchr/testify v1.10.0
github.com/tchap/go-patricia v2.3.0+incompatible
golang.org/x/oauth2 v0.26.0
gopkg.in/libgit2/git2go.v27 v27.0.0-00010101000000-000000000000
)
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/google/go-querystring v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/rivo/uniseg v0.2.0 // indirect
github.com/rthornton128/goncurses v0.0.0-20240804152857-da6485a3b6d7 // indirect
github.com/sirupsen/logrus v1.9.3 // indirect
github.com/stretchr/objx v0.5.2 // indirect
go4.org v0.0.0-20230225012048-214862532bf5 // indirect
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 // indirect
golang.org/x/sys v0.5.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
Additional Information:
This issue was identified as part of our research project focused on automating the analysis of GOPATH projects to provide accurate dependency versions for seamless migration to Go Modules. We value your feedback and would appreciate any comments or suggestions regarding this approach.
Looking forward to your response!
Could we update README.md to help other developers use the Go module to build the projects or submit pull requests with go.mod to apply our suggestions? @rgburke
