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

API breakage between 1.12.0 and 1.13.0 #40

Open
stapelberg opened this issue Jul 24, 2017 · 0 comments
Open

API breakage between 1.12.0 and 1.13.0 #40

stapelberg opened this issue Jul 24, 2017 · 0 comments

Comments

@stapelberg
Copy link

Thanks for providing this package!

https://github.com/JamesClonk/vultr/blob/1.12.0/lib/dns.go has “type DnsDomain”
https://github.com/JamesClonk/vultr/blob/1.13.0/lib/dns.go has “type DNSDomain”

This change has caused issues in the lego Debian packaging: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=869270

Could you provide type aliases and wrapper functions to prevent API breakages in the future please?

Also, your version number looks like semantic versioning. But, as per the following quote from http://semver.org, the 1.13.0 release is a clear violation (it makes an incompatible API change without incrementing the major version). Are you not using semantic versioning? If so, that’d be worth calling out in the README.

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.

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

1 participant