Skip to content
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

Create annotated tags for releases #13

Open
benma opened this issue Apr 22, 2016 · 2 comments
Open

Create annotated tags for releases #13

benma opened this issue Apr 22, 2016 · 2 comments

Comments

@benma
Copy link

benma commented Apr 22, 2016

Hi

It would be great if you tagged the current HEAD with v1.0.0, and in the future, occasionally bump the version and make new tags with new releases. I suggest using the semver.org versioning scheme, where you have major.minor.patch, and you bump the major for incompatible changes and the minor for compatible changes to the API.

@alexjlockwood
Copy link
Owner

Thanks for the suggestion! There are a few changes I've been wanting to make to this library to support new features but am not familiar with how versioning works in go, TBH. I've been afraid that incompatible changes I make will break people who have already go-getted this library for their own projects. Do you have any suggestions on where I could read up on this?

@benma
Copy link
Author

benma commented Apr 24, 2016

As far as I know, there is no standard way of doing versioning in Go projects.

Since Go 1.5, vendoring is the recommended way of handling dependencies:
https://golang.org/cmd/go/#hdr-Vendor_Directories

If people use this and vendor a specific version of your package, incompatible upgrades to it won't break the project (i.e. when it is fetched with go get, which just gets master).

I suggest to follow http://semver.org/, as it is pretty simple (see my first comment).
It is of course also a good idea to maintain a changelist that details the changes, and a way forward for breaking changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants