Skip to content

COMPATIBILITY.md

Latest commit

 

History

History
66 lines (51 loc) · 5.53 KB

COMPATIBILITY.md

File metadata and controls

66 lines (51 loc) · 5.53 KB
Raw

Compatibility Matrix

This page documents the minimum and recommended development tools required to build and run the ComplyCube Flutter sample app.

It includes:

  • Baseline requirements (what we recommend you install locally).
  • A CI-validated matrix (generated automatically) across multiple Flutter versions.

Key concepts

  • Flutter SDK version – Flutter’s stable channel moves quickly. This repository validates against:
    • Minimum (older stable): Flutter 3.27.4
    • Recommended (project baseline): Flutter 3.29.3
    • Latest stable (tracked by CI): Flutter 3.38.5
  • Build JDK (Android) – the Java runtime used to execute Gradle and the Android Gradle Plugin (AGP). AGP 8.x requires Java 17+ to run.
  • AGP / Gradle wrapper – the Android toolchain versions used by this repo live in:
    • android/settings.gradle (AGP + Kotlin plugin)
    • android/gradle/wrapper/gradle-wrapper.properties (Gradle wrapper)
  • iOS toolchain – iOS builds require Xcode, CocoaPods and Ruby. CI records the detected versions on the macOS runner, but your local versions may differ.

Minimum vs. recommended (baseline)

Component Minimum Recommended Notes
Flutter SDK (stable) 3.27.4 3.29.3 CI also tests latest stable (currently 3.38.5).
Android Build JDK (runs Gradle/AGP) 17 17 AGP 8.x requires Java 17+ to run.
Gradle wrapper 8.9 8.9 Use android/gradlew (never your system Gradle).
Android Gradle Plugin (AGP) 8.2.2 8.2.2 Repo baseline.
Kotlin plugin 1.9.24 1.9.24 Repo baseline.
Android SDK – compileSdk / targetSdk (resolved by Flutter) 35 (current) CI records the resolved values for each Flutter version.
iOS deployment target 13.0 13.0 Podfile sets platform :ios, '13.0'.
CocoaPods 1.16.x 1.16.x pod install required before iOS build.

Validated combinations (CI)

This table is generated automatically by CI. Do not edit it manually.

Row Platform Flutter Runner OS Build JDK AGP Gradle Kotlin Resolved compileSdk/targetSdk/minSdk Xcode / Swift CocoaPods / Ruby Result
android-flutter-3.27.4-jdk17 android 3.27.4 Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 17 8.2.2 8.9 1.8.22 ❌ fail
android-flutter-3.27.4-jdk21 android 3.27.4 Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 21 8.2.2 8.9 1.8.22 ❌ fail
android-flutter-3.29.3-jdk17 android 3.29.3 Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 17 8.2.2 8.9 1.8.22 ❌ fail
android-flutter-3.29.3-jdk21 android 3.29.3 Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 21 8.2.2 8.9 1.8.22 ❌ fail
android-flutter-latest-stable-jdk17 android stable Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 17 8.2.2 8.9 1.8.22 ❌ fail
android-flutter-latest-stable-jdk21 android stable Linux runnervm3jyl0 6.17.0-1015-azure #15~24.04.1-Ubuntu SMP Wed May 6 22:37:49 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux 21 8.2.2 8.9 1.8.22 ❌ fail
ios-flutter-3.27.4 ios 3.27.4 Darwin sat12-bq161-b375d951-32e9-474d-8179-da27aa0c5aff-3E909258315F.local 24.6.0 Darwin Kernel Version 24.6.0: Tue Apr 21 20:18:00 PDT 2026; root:xnu-11417.140.69.710.16~1/RELEASE_ARM64_VMAPPLE arm64 8.2.2 8.9 1.8.22 Xcode 16.4 Build version 16F6 / Apple Swift version 6.1.2 (swiftlang-6.1.2.1.2 clang-1700.0.13.5) 1.16.2 / ruby 3.3.11 (2026-03-26 revision 1f2d15125a) [arm64-darwin24] ❌ fail
ios-flutter-3.29.3 ios 3.29.3 Darwin sat12-bq164-3b060fed-f032-4a81-8102-0bcea4031e80-1A26B2C8D075.local 24.6.0 Darwin Kernel Version 24.6.0: Tue Apr 21 20:18:00 PDT 2026; root:xnu-11417.140.69.710.16~1/RELEASE_ARM64_VMAPPLE arm64 8.2.2 8.9 1.8.22 Xcode 16.4 Build version 16F6 / Apple Swift version 6.1.2 (swiftlang-6.1.2.1.2 clang-1700.0.13.5) 1.16.2 / ruby 3.3.11 (2026-03-26 revision 1f2d15125a) [arm64-darwin24] ❌ fail
ios-flutter-latest-stable ios stable Darwin iad20-gt1024-333b83b4-2a17-46ea-8543-0596587cdaef-464BE093C83A.local 24.6.0 Darwin Kernel Version 24.6.0: Tue Apr 21 20:18:00 PDT 2026; root:xnu-11417.140.69.710.16~1/RELEASE_ARM64_VMAPPLE arm64 8.2.2 8.9 1.8.22 Xcode 16.4 Build version 16F6 / Apple Swift version 6.1.2 (swiftlang-6.1.2.1.2 clang-1700.0.13.5) 1.16.2 / ruby 3.3.11 (2026-03-26 revision 1f2d15125a) [arm64-darwin24] ❌ fail

Notes

  • Android rows build a Debug APK using the repo's Gradle wrapper (android/gradlew).
  • iOS rows build with flutter build ios --no-codesign and run pod install.

How to use this matrix

  1. Prefer the recommended versions in the table above.
  2. If you must deviate, pick a combination that is validated as ✅ pass in the CI table.
  3. If your build fails, run the repo doctor scripts first:
  • scripts/doctor.sh (macOS/Linux)
  • scripts/doctor.ps1 (Windows)