-
Notifications
You must be signed in to change notification settings - Fork 372
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 will happen when upgrading the library #315
Comments
KateGo520
changed the title
Errors you may encounter when upgrading this dependency
Errors will happen when upgrading the libraries
Jun 19, 2020
@JackEllis @A5hleyRich Could you help me review this issue? Thx :p |
KateGo520
changed the title
Errors will happen when upgrading the libraries
Errors will happen when upgrading the library
Jun 28, 2020
By the way, have you ever encountered such errors when upgading the libraries? |
@JokerQyou Wish you every success in migrating to Go Modules! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
(The purpose of this report is to alert
usefathom/fathom
to the possible problems whenusefathom/fathom
try to upgrade the following dependencies)An error will happen when upgrading library urfave/cli:
github.com/urfave/cli
-Latest Version: v2.2.0 (Latest commit d648edd on 6 Mar)
-Where did you use it:
https://github.com/usefathom/fathom/search?q=urfave%2Fcli&unscoped_q=urfave%2Fcli
-Detail:
This problem was introduced since urfave/cli v1.22.1 . If you try to upgrade urfave/cli to version ** v1.22.1** and above, you will get an error--- no package exists at "github.com/cpuguy83/go-md2man/v2/md2man"
I investigated the libraries (urfave/cli >= v1.22.1) release information and found the root cause 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…).
[*] You can see who will be affected here: [1 module-unaware users, i.e., ExploreDigital/stealth]
https://github.com/search?q=usefathom%2Ffathom+filename%3Avendor.conf+filename%3Avendor.json+filename%3Aglide.toml+filename%3AGodep.toml+filename%3AGodep.json
2. Maintaining v2+ libraries that use Go Modules in Vendor directories.
If
usefathom/fathom
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.
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
urfave/cli
have 1694 module-unaware users in github, such as: alena1108/cluster-controller, nathan-jenan-rancher/example-kontainer-engine-driver, containerd/containerd…https://github.com/search?q=urfave%2Fcli+filename%3Avendor.conf+filename%3Avendor.json+filename%3Aglide.toml+filename%3AGodep.toml+filename%3AGodep.json
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: