Breakage api check (#979)

* script to check api breakage

* check api breakage part of sanity check

Author: maios

.circleci/config.yml

@@ -8,6 +8,18 @@ orbs:
 
 commands:
 
+  check-api-breakage:
+    steps:
+      - run:
+          name: Add pub-cache to PATH
+          command: echo 'export PATH="$HOME/.pub-cache/bin:$PATH"' >> $BASH_ENV
+      - run:
+          name: Install dart_apitool
+          command: dart pub global activate dart_apitool 0.21.1
+      - run:
+          name: Check API breakage
+          command: bash scripts/check_api_breakage.sh
+
   inject-netrc-credentials:
     steps:
       - run:
@@ -224,7 +236,7 @@ jobs:
     steps:
       - checkout
       - flutter/install_sdk_and_pub:
-          version: 3.24.3
+          version: 3.27.0
       - run:
           name: Check license
           command: bash scripts/license.sh --mode validate
@@ -235,6 +247,7 @@ jobs:
           name: Check all tests are in the test suite
           command: dart ../scripts/check_test_suite.dart
           working_directory: example
+      - check-api-breakage
 
 workflows:
   build:

scripts/check_api_breakage.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -e
+
+# Check if dart_apitool is activated globally
+if ! dart pub global list | grep -q 'dart_apitool'; then
+  echo "dart_apitool is not activated globally. Please run: dart pub global activate dart_apitool"
+  exit 1
+fi
+
+# Get the current stable version of mapbox_maps_flutter on pub.dev
+PACKAGE_NAME="mapbox_maps_flutter"
+PACKAGE_VERSION=$(curl -s "https://pub.dev/api/packages/$PACKAGE_NAME" | grep -o '"latest":{"version":"[^"]*' | grep -o '[0-9]\+\(\.[0-9]\+\)*')
+echo "Current stable version of mapbox_maps_flutter: $PACKAGE_VERSION"
+
+# Get the path of local mapbox-maps-flutter
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+LOCAL_PACKAGE_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+# Run dart_apitool to check for API breakage
+dart-apitool diff \
+  --old pub://$PACKAGE_NAME/$PACKAGE_VERSION \
+  --new $LOCAL_PACKAGE_ROOT \
+  --version-check-mode=onlyBreakingChanges