Migration Guide

Versioning#

We will always release a major version of photo_editor_sdk if we break the existing Flutter API.

However, since the module depends on the native PhotoEditor SDK for android and ios as described in the architecture section, the versioning of the module depends on both the native APIs as well as the dedicated Flutter API. Since not every major release of the native SDKs also results in breaking Flutter API changes, you will see breaking changes only regarding the integration of the native modules in minor releases.

Therefore, please carefully read the CHANGELOG before upgrading your photo_editor_sdk version and check whether you will need to update your integration of the module.

Update native SDK versions#

Regardless of the photo_editor_sdk version you are using, you can also update the underlying native dependencies, e.g., to retrieve a native bugfix that has not yet been published for the Flutter plugin.

iOS#

For iOS, you can simply update the underlying SDK by running:

(cd ios && pod update imglyKit)

Android#

For Android, you can simply update the underlying SDK by changing the version number inside the android/build.gradle file:

buildscript {
    ...
    dependencies {
        ...
-       classpath 'ly.img.android.sdk:plugin:10.4.0'
+       classpath 'ly.img.android.sdk:plugin:10.9.0'
        ...
    }
}

Migration Guides#