The Google Maps Platform team regularly updates SDKs with new features, bug fixes, and performance improvements. This page provides guidance on how to manage your dependencies on mobile SDKs.
Which version to link to?
- For mission-critical apps, link to the latest dot release of the major version that you are using (X.*). This method requires you to make app updates at least once a year, when a new major version is released.
- For non-critical apps, link to any fixed version. When you receive a deprecation notice for that fixed version, you will have 12 months to make your updated app code available to your users. This method means less frequent maintenance work, but the work may involve a greater amount of resources to adapt, rewrite, and test than would be required for annual updates. Such work would have to be completed before the deprecation.
Project Owners with monitored email addresses receive proactive notifications about changes that impact each of their projects. Stay informed about major updates, deprecations, and other changes.
Installation
Always specify a version number in your dependencies instead of using an optimistic operator
(~>
) since that can lead to unpredictable and unrepeatable builds. The
Maps SDK for iOS adheres to semantic versioning,
and new major version releases include breaking changes.
Using CocoaPods
An example Podfile dependency using Podfile syntax:
source 'https://github.com/CocoaPods/Specs.git' platform :ios, '13.0' target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleMaps', '7.0.0' end
Using Carthage
An example Cartfile dependency using Cartfile syntax:
binary "https://dl.google.com/geosdk/GoogleMaps.json" == 6.2.1
Maintenance and upgrade
To build with the latest improvements, regularly check for newer versions and update your version specifications. If you are updating to a new major version, check the release notes for backwards-incompatible changes and how to update your code.
Using Cocoapods
Open a terminal and go to the directory containing the
Podfile
:cd <path-to-project>
- Run
pod outdated
to see if a newer version of the Maps SDK for iOS is available. - If a newer version of the SDK is found, update your
Podfile
with this new version. See Specifying pod versions to learn how to set a specific version in yourPodfile
. - Run
pod update
. - Make any necessary changes as a result of the upgrade. See the Release Notes for a list of the changes in each release.
- Clean and rebuild your project by selecting Product > Clean and then Product > Build
Using Carthage
Open a terminal and go to the directory containing the
Podfile
:cd <path-to-project>
- Run
carthage outdated
to see if a newer version of the Maps SDK for iOS is available. - If a newer version of the SDK is found, update your
Cartfile
with this new version. See Version requirements to learn how to set a specific version in yourCartfile
. - Run
carthage update
. - Make any necessary changes as a result of the upgrade. See the Release Notes for a list of the changes in each release.
- Clean and rebuild your project by selecting Product > Clean and then Product > Build
Manual
Get the link to the latest source files at Installing the SDK.
In addition to polling for newer versions, Google Cloud project owners receive emails about backwards incompatible changes that may affect their projects. To get proactive notification about backwards incompatible changes, assign the owner role with a monitored email address for each of your projects.