-
Notifications
You must be signed in to change notification settings - Fork 731
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
Errors you may encounter when upgrading the library #475
Comments
Yeah i've tried to upgrade to go modules before and hit the same issue, though i didn't spend any time investigating into it. |
@sosedoff Thanks for your reply. This report is a warm prompt for you to prevent or combat this issue. Just let you know the problem if you upgrade this dependency in near future. Hope this can help you. |
You hit the same issue when you upgrade to Modules? Could you tell me more details? :D? |
Switch to Go modules / Gin upgrade is in master. |
(The purpose of this report is to alert
sosedoff/pgweb
to the possible problems whensosedoff/pgweb
try to upgrade the following dependencies)An error will happen when upgrading library gin-gonic/gin:
github.com/gin-gonic/gin
-Latest Version: v1.6.3 (Latest commit 6a8b8b6 on 3 May)
-Where did you use it:
https://github.com/sosedoff/pgweb/search?l=Go&q=gin-gonic%2Fgin
-Detail:
This problem was introduced since gin-gonic/gin v1.6.0 . Now you used the version v1.3.0 . If you try to upgrade gin-gonic/gin to version v1.6.0 and above, you will get an error--- no package exists at "github.com/go-playground/validator/v10"
I investigated the libraries (gin-gonic/gin >= v1.6.0) release information and found the root casue of this issue is that----
These dependencies all added Go modules in the recent versions.
They all comply with the specification of "Releasing Modules for v2 or higher" available in the Modules documentation. Quoting the specification:
physical path
. So earlier versions of Go (including those that don't have minimal module awareness) plus all tooling (like dep, glide, govendor, etc) don't haveminimal module awareness
as of now and therefore don't handle import paths correctly See golang/dep#1962, golang/dep#2139.Solution
1. Migrate to Go Modules.
Go Modules is the general trend of ecosystem, if you want a better upgrade package experience, migrating to Go Modules is a good choice.
Migrate to modules will be accompanied by the introduction of virtual paths(It was discussed above).
Then the downstream projects might be negatively affected in their building if they are module-unaware (Go versions older than 1.9.7 and 1.10.3; Or use third-party dependency management tools, such as: Dep, glide, govendor…).
2. Maintaining v2+ libraries that use Go Modules in Vendor directories.
If
sosedoff/pgweb
want to keep using the dependency manage tools (like dep, glide, govendor, etc), and still want to upgrade the dependencies, can choose this fix strategy.Manually download the dependencies into the vendor directory and do compatibility dispose(materialize the virtual path or delete the virtual part of the path). Avoid fetching the dependencies by virtual import paths. This may add some maintenance overhead compared to using modules.
There is 1 module user downstream, such as leogsouza/meower…)
https://github.com/search?q=sosedoff%2Fpgweb+filename%3Ago.mod
As the import paths have different meanings between the projects adopting module repos and the non-module repos, materialize the virtual path is a better way to solve the issue, while ensuring compatibility with downstream module users. A textbook example provided by repo
github.com/moby/moby
is here:https://github.com/moby/moby/blob/master/VENDORING.md
https://github.com/moby/moby/blob/master/vendor.conf
In the vendor directory,
github.com/moby/moby
adds the /vN subdirectory in the corresponding dependencies.This will help more downstream module users to work well with your package.
3. Request upstream to do compatibility processing.
The
gin-gonic/gin
have 2110 module-unaware users in github, such as: yogaagungk/assets-management, aduermael/dockerblog, gdevillele/calvados…https://github.com/search?q=gin-gonic%2Fgin+filename%3Avendor.conf+filename%3Avendor.json+filename%3Aglide.toml+filename%3AGodep.toml+filename%3AGodep.json&type=Code
Summary
You can make a choice when you meet this DM issues by balancing your own development schedules/mode against the affects on the downstream projects.
For this issue, Solution 1 can maximize your benefits and with minimal impacts to your downstream projects the ecosystem.
References
Do you plan to upgrade the libraries in near future?
Hope this issue report can help you ^_^
Thank you very much for your attention.
Best regards,
Kate
The text was updated successfully, but these errors were encountered: