This is a story of how Go’s package management system and GitHub fought a war, and how the war was lost (by me).
Go references packages by a repository name, so if you want to important a package you write
something like import "github.com/volatiletech/sqlboiler/queries/qm". It’s simple, right? Yes, it
is.
When you want to submit a proposed patch to a repo on GitHub, you fork, make a new branch (because
you’re not a monster who makes a PR from master), and then you submit a PR. When you fork you copy
the repo to a new user/org. So when I wanted to make some tweaks to sqlboiler for $work at
ActiveState I ended up with a new repo at github.com/ActiveState/sqlboiler. It’s simple, right?
Yes, it is.
But wait, I import the code by referring to the repo name. That means if I want to test my local
changes in some $work code I have to change the import to use my new forked repo. So in my work code
I replace all uses of import "github.com/volatiletech/sqlboiler/queries/qm" with
import "github.com/ActiveState/sqlboiler/queries/qm". It’s a little annoying but it’s just a quick
grep -rl github.com/ActiveState | xargs perl -pi -e 's{github.com/volatiletech/sqlboiler}{github.com/ActiveState/sqlboiler}g'.
It’s simple, right? Yes, it is.
Wait, no, it’s not simple. Because if you look inside the qm package I’m importing,
you’ll see that it imports github.com/volatiletech/sqlboiler/queries/qmhelper. That means that
even though I might be importing my forked repo, that forked repo is still importing from the
original repo. So if I need to change both the qm and qmhelper packages, my changed qm will
not see my changes to qmhelper. So I need to go into my forked repo and change all
volatiletech/sqlboiler references to ActiveState/sqlboiler!
And I need to commit and push that change to GitHub because we’re using dep for package management, which will always fetch the referenced code from its repo. I can point dep at a branch, which is great, but I need to point it at a branch where I’ve renamed all those imports or else it will end up vendoring both my fork and the original repo for sqlboiler.
So now I have a branch that has all my bug fixes plus import renaming. But I cannot submit this branch as a PR. The maintainer doesn’t want to change all the imports. I only had to do that so I could use my forked repo locally. So now I have to maintain one branch per bug fix plus an integration branch that includes all my bug fixes and the import renaming.
I’ve been using Go for several years now, and the longer I use it the less I like it. It’s “simple” design choices consistently cause me pain because they’re too simple. I think there’s a good reason that every other language’s package system has a layer of indirection between the name of the import and the loading of that code.
Will Go modules fix this? Not as far as I can tell. The module names are still repo names, which means I’d have to do the same renaming dance if a repo’s module imports another module from the same repo.
And that’s the story of the war between Go and GitHub, where the only loser was me and anybody else trying to test their fixes to someone else’s Go package.
Comments
Greg, on 2019-03-03 17:51, said:
Go modules provides a replace directive that solves this,
https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive.
Greg, on 2019-03-03 17:53, said:
Actually, dep also provides this functionality with a “source” option.
Dave Rolsky, on 2019-03-03 19:15, said:
I knew about dep’s source option but I don’t think it will handle the naming issue. I’d still have
to change the actual import statements. It looks like go module replace directive does take care of
the entire problem though, which is good.
Gautam Dey, on 2019-03-03 21:49, said:
The best way to do this I have found is to use a new remote that points to your repository.
On github fork like usual.
On you computer go to the original repo that has been checked out.
In that repo add a new remote that points to your repository.
Branch and make changes as usual.
But now push the branch to the remote instread of the origin.
No need to change import paths.
Dave Rolsky, on 2019-03-03 22:00, said:
That’s a clever solution!
Kjell, on 2019-03-04 00:53, said:
That is a good solution. Here is giteas docs regarding forking
https://docs.gitea.io/en-us/hacking-on-gitea/
Matthew Persico, on 2019-03-04 16:37, said:
The best thing to do is to STOP USING GITHUB AS A FREAKING PACKAGING SYSTEM!. Not directed at you,
obviously, but really, can we teach all these whipper snappers that the Internet should be used as a
REFERENCE, not as a resource in the critcal path of execution?
Dave Rolsky, on 2019-03-04 17:23, said:
Well, yeah, but that’s Go for you. And I don’t think Rob Pike or Ken Thompson really qualify as
young whippersnappers.