Kingfisher: Broken Semantic Versioning

Created on 4 Oct 2019  ·  3Comments  ·  Source: onevcat/Kingfisher

Check List

Thanks for considering to open an issue. Before you submit your issue, please confirm these boxes are checked.

Issue Description

What

You've changed Image to KFCrossPlatformImage along with a bunch of other symbol names in https://github.com/onevcat/Kingfisher/commit/754ec2ea4a2627387ce3535c5e5cb217d4442580#diff-650b8c6577862696b42f0418207910de without bumping a major version (you've bumped a minor/patch version 5.8.10).

This breaks semantic versioning. Libraries that depend on your framework are broken. Source-breaking changes should not be a path/minor version bump.

It seems you've also made a bunch of other non-backwards-compatible changes to this library. I'd like to understand what's the versioning scheme you follow here. As a library maintainer there should be a clear versioning system so other consumers can count on the Major/Minor/Patch system while designing their own solutions/apps that depend on your library.

Here's one example of this:
https://github.com/RxSwiftCommunity/RxKingfisher/issues/17

Most helpful comment

It's an accident. I will make it compatible again in the next patch later today. Sorry for the inconvenience it caused!

All 3 comments

It's an accident. I will make it compatible again in the next patch later today. Sorry for the inconvenience it caused!

No worries at all, just wanted to make sure if we should release a patch on our side or wait for a new release. Thank you so much 🙏 !

Version 5.8.2 was released for this. Now if you resolve the Kingfisher version to 5.8.2, your code should work as is.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

rainerjungwirth picture rainerjungwirth  ·  4Comments

nickgate picture nickgate  ·  4Comments

duongdangng picture duongdangng  ·  5Comments

wudijimao picture wudijimao  ·  3Comments

sadeghgoo picture sadeghgoo  ·  4Comments