API versioning

[miekg]

API versioning

[miekg]

[ Quoting [email protected] in "[dns] API versioning (#26)..." ]

This is a follow-up to the remark I made about that in #25:

Just thinking out loud here:

It'd be nice if there was some way to have my build break when the dns API
changes in maybe-incompatible ways. Because I use cgo I build my server on 3-4
different boxes, so my process for "keeping in sync" has just been to go get -u
-v, but then it's hard to know exactly which version of dns I got.

For geodns itself I build it with

REVISION=git rev-parse --short=8 HEAD
go build -ldflags "-X main.gitVersion $REVISION" -v

... maybe I should just add another version like that for the dnsGitVersion.

As for you making a subdirectory for "v2", that sounds like a huge hassle. I
think just do it on a branch, and if you need to keep v1 around when v2 is
ready to be merged setup a separate git repository that people can import and
alias to dns if they need the old version.

Haven't made the v2 switch yet, because as you say "it's a hassle" :)
Problem is that 'go get' does not know how to deal with branches afaik.
Same goes for tags.

I've seen the makefile of geodns and I like the idea of embedding versioning
info the binary (the one feature I miss from svn: $Id$), but doing with
git is incompatible with 'go get', so for a package like dns this can not
be done.

Thanks for saying, don't do manual (v2) branches, I'll just have to be more
prudent about the code I submit into the master branch.

Regards,

Miek Gieben                                                   http://miek.nl