search

GoogleCloudPlatform / recaptcha-enterprise-flutter

Apache License 2.0
23 stars 8 forks source link

Breaking the API should have be done in a major version #17

Closed mateusfccp closed 1 year ago

mateusfccp commented 1 year ago

Recently, 18.2.2 has been release with an API breakage.

I propose we bump the version to 19.0.0.

In our app, we had a break because of this. Although it's not something hard to change, I don't think we should break API in minor or patch versions.

mcorner commented 1 year ago

The version for our flutter package is linked to the underlying SDK (long debates about this, but it generally reduces confusion). The underlying API didn't change just the Flutter wrapper. The flutter wrapper itself is in "public preview" so we are being somewhat more liberal about breaking changes. You can stick with the old version if it is inconvenient or change your code. There is an example there and should just be a few lines. LMK if you need any help.

mateusfccp commented 1 year ago

Yeah, I don't know why this has been decided this way, but then won't we have any way to know if a breaking change has been introduced?

I mean, as an API consumer I don't really care if the underlying API has changed or not, I only care for what I am directly consuming (the wrapper).

mcorner commented 1 year ago

Until we declare it as GA, it is subject to change (see warning at the top of the README). That said, I don't think it is likely we will change it again without a change in the underlying sdk. And when that happens we will be following more conventional semantic versioning.