how to version packages in golang?

go, package, version

Solution

The official version, from the GO FAQ:

If you're using an externally supplied package and worry that it might change in unexpected ways, the simplest solution is to copy it to your local repository. (This is the approach Google takes internally.) Store the copy under a new import path that identifies it as a local copy.

There are many alternative to that approach, mainly based on declaring the exact version of those projects you are using.

See for instance "Dead Simple Dependencies in Go -- Keep it simple and keep your sanity." (based on `emil2k/vend`)

The main different options for Go Dependency Management are listed at:

"Go Package Management -- A summary of dependency management in Go" (And its associate GOPM mailing list)

Update July 2015:

- the official vendoring approach from Go team is discussed here.

- an alternative go build tool called "gb" is proposed at getgb.io by Dave Cheney.

Update Q4 2017: as mentioned below, `go dep` is the official tool for pinning version of dependencies (even though that pinning approach is not without criticism: see "The cargo cult of versioning"). It should be merged into the toolchain when Go 1.10 development begins, according to its roadmap.

Update Q2 2018: `go dep` has been replaced by `go mod` (modules) in Go 1.11, following works on `vgo`.

Problem

I've read a whole bunch of articles and SO questions on importing 3rd party go packages which all seems straight forward, but what I don't understand is that none that I have read make any references to versioning. In Dartlang there's the pubspec file that defines your package including its version and its dependencies including their required versions. What if I do a `go get github.com/gorilla/sessions` and write my app then 6 months later I have to clear my directories and re get everything again, in which time that package has been update and broken backwards compatibility with my code that was using the older version?

Original source

Related problems