From 126d28d978d4360e7a2f1d7d55329f6763757b2c Mon Sep 17 00:00:00 2001 From: Dale Hawkins <107309+dkhawk@users.noreply.github.com> Date: Wed, 5 Aug 2026 12:05:21 -0600 Subject: [PATCH] docs: document Google Navigation SDK compatibility (#1728) Add documentation to README.md and MIGRATION.md explaining how to exclude play-services-maps when integrating the Google Navigation SDK for Android to prevent duplicate class conflicts. Fixes #1728 TAG=agy CONV=663b1e11-fec2-4ba4-9b7b-e1dafbf81d2c --- MIGRATION.md | 10 ++++++++++ README.md | 12 ++++++++++++ 2 files changed, 22 insertions(+) diff --git a/MIGRATION.md b/MIGRATION.md index 9fa8aa337..7ac44d738 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -26,6 +26,16 @@ android-maps-utils = { group = "com.google.maps.android", name = "android-maps-u ``` This aggregator dynamically and transitively pulls all individual submodules. Alternatively, you can choose to import only the specific submodules your app requires (e.g., `android-maps-utils-core` and `android-maps-utils-clustering`). +> [!IMPORTANT] +> **Google Navigation SDK Compatibility**: If your project integrates the Google Navigation SDK for Android, add an exclusion for `play-services-maps` to prevent duplicate class conflicts: +> ```kotlin +> configurations.all { +> if (name.contains("navigation", ignoreCase = true)) { +> exclude(group = "com.google.android.gms", module = "play-services-maps") +> } +> } +> ``` + --- ## 2. Kotlin Property Syntax Overrides (Breaking Changes for Kotlin Callers) diff --git a/README.md b/README.md index 191de5bbe..6869e3816 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,18 @@ dependencies { } ``` +### Compatibility with Google Navigation SDK for Android + +If your project integrates the [Google Navigation SDK for Android](https://developers.google.com/maps/documentation/navigation/android-sdk), you must exclude the transitive `play-services-maps` dependency to prevent duplicate class conflicts: + +```kotlin +configurations.all { + if (name.contains("navigation", ignoreCase = true)) { + exclude(group = "com.google.android.gms", module = "play-services-maps") + } +} +``` + ## Sample App