ublox icon indicating copy to clipboard operation
ublox copied to clipboard

0.4.5 breaks API over 0.4.2

Open Danvil opened this issue 2 years ago • 2 comments

I have a project built against 0.4.2 which suddenly stopped working with compiler errors.

cargo is free to upgrade between "patch" versions, like from 0.4.2 to 0.4.5 as patch versions are not allowed to change the API. Some changes from 0.4.2 to 0.4.5 introduced API changes and should have come with an increase in the minor version number, e.g. "0.5.0".

It is too late for this now, but would be great for the future to only do API changes only via minor version number increase. More info here: https://semver.org

Workaround is to pin the version using "=0.4.2", but this is generally considered bad practice.

Danvil avatar Jan 26 '24 19:01 Danvil

We should add https://github.com/obi1kenobi/cargo-semver-checks to CI so we're more aware of this kind of breakage in the future and so that we can describe API changes up front in the changelog with minimal effort.

CramBL avatar Mar 09 '25 15:03 CramBL

Totally agree. Let's add that to the CI and close this issue when we make a new major release.

andrei-ng avatar Mar 09 '25 17:03 andrei-ng

@Danvil , thank you for reporting this. We have added semver checks to our CI and hopefully this won't happen again in the future. There is a new major release as of today, so I am closing this.

andrei-ng avatar Mar 28 '25 19:03 andrei-ng