Skip to content

API breakage between 1.12.0 and 1.13.0 #40

@stapelberg

Description

@stapelberg

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions