-
Notifications
You must be signed in to change notification settings - Fork 20
Notes on migrating to a Go mono repo
Paul Jolly edited this page Apr 7, 2018
·
31 revisions
Ultimately this wiki will become a blog post, but maintaining here for now until things settle.
- Ultimately to migrate all
myitcv.io/...packages to a mono-repo, housed at https://github.com/myitcv/x - This mono-repo should support
vgoand, critically, be backwards compatible with "old"go get - https://godoc.org/ should work as expected
- Have multiple modules within the mono-repo,
myitcv.io/reactbeing one of them. This will mean that we have submodules within the outermyitcv.iomodule - Drop any existing
_vendordirectories that were previously used to "cache" (dev) dependencies, e.g.myitcv.io/react/_vendor - categorise issues/PRs in much the same way as the Go project does, e.g.
myitcv.io/reactissues would be prefixed byreact,react/cmd/reactGenetc
- Less overhead in terms of maintaining multiple repos, issue lists, CI setups etc
- ...
- It's a change from where we are today; loss of continuity, history etc (although the history of the old repos will remain intact in the original repo)
- ...
- The
go-importgitmeta tag for allmyitcv.io/...packages needs to be the root of all packages,myitcv.ioin this case:
$ curl https://myitcv.io/gogenerate?go-get=1
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="go-import" content="myitcv.io git https://github.com/myitcv/x">
<meta name="go-source" content="myitcv.io https://github.com/myitcv/x/wiki https://github.com/myitcv/x/tree/master{/dir} https://github.com/myitcv/x/blob/master{/dir}/{file}#L{line}">
<meta http-equiv="refresh" content="0; url=https://godoc.org/myitcv.io/gogenerate">
</head>
<body>
Redirecting to docs at <a href="https://godoc.org/myitcv.io/gogenerate">godoc.org/myitcv.io/gogenerate</a>...
</body>
</html>-
vgoshould work without needing to publish modules (see "Publishing" section https://research.swtch.com/vgo-module). However, per Issue: https://github.com/golang/go/issues/24687#issuecomment-379056477 there appear to be some issues within submodules when resolved from VCS. Hence in the meantime (and indeed for the longer term) I am publishing pre-release modules via https://github.com/myitcv/pubx. Thego-importmodmeta tag is then used to refer to these published packages:
$ curl https://myitcv.io/blah2?go-get=1
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="go-import" content="myitcv.io git https://github.com/myitcv/x">
<meta name="go-import" content="myitcv.io/blah2 mod https://raw.githubusercontent.com/myitcv/pubx/master">
<meta name="go-source" content="myitcv.io https://github.com/myitcv/x/wiki https://github.com/myitcv/x/tree/master{/dir} https://github.com/myitcv/x/blob/master{/dir}/{file}#L{line}">
<meta http-equiv="refresh" content="0; url=https://godoc.org/myitcv.io/blah2">
</head>
<body>
Redirecting to docs at <a href="https://godoc.org/myitcv.io/blah2">godoc.org/myitcv.io/blah2</a>...
</body>
</html>- It appears however that the old
go getdoes not like there being twogo-importmeta tags which satisfy amyitcv.io/...package. Issue: https://github.com/golang/go/issues/24751 - The issue with the dual-meta tags also affects https://godoc.org/, because it (https://godoc.org/) uses
go getin order to access code. Otherwise, however, things appear to work well: https://godoc.org/myitcv.io/blah
- Much like the original motivation for committing
_vendorto my repos, I want my CI to behave in a deterministic way. But I don't want to have to commit all those dependencies to my mono-repo (which would massively burden users of my code). Hence I am maintaining https://github.com/myitcv/cachex. The CI then uses https://github.com/myitcv/cachex augmented with https://github.com/myitcv/pubx formyitcv.io/...packages as itsGOPROXY. This means if a dependency is missing fromcachexorpubxthen the CI build will fail. It is worth noting that that both https://github.com/myitcv/cachex and https://github.com/myitcv/pubx are in effect append-only repositories (although I don't currently have anything that enforces this - see TODO)
- Do we need to have a
go.modfile at the repo root? i.e. https://github.com/myitcv/x/blob/master/go.mod
- Enforce https://github.com/myitcv/cachex and https://github.com/myitcv/pubx being append-only repositories