Automatically download and upload dSYM symbolication files from iTunes Connect for Bitcode iOS apps using fastlane
When submitting iOS apps to the App Store with Bitcode enabled, your app gets recompiled by Apple, to be optimized for specific devices and architectures. While Bitcode is optional, it’s more and more encouraged by Apple, and even required for watchOS and tvOS apps.
Due to the fact that recompiling happens on Apple’s servers, third party crash reporters don’t have access to the symbolication files, which are required to properly associate the crash stack trace with the exact files and line numbers in your source code.
The current solution to solve this for Bitcode enabled apps is to manually download the dSYM files from Apple and upload them to your crash reporting service. Downloading the files can be done either using Xcode or iTunes Connect.
Download dSYM symbolication files using the Xcode Organizer
Download dSYM symbolication files from iTunes Connect
The problem with this approach is not only the time you spend doing this manually for every single release, but also the lack of automation. There was no way to automatically do this process after every release, or just periodically on every day, so you end up spending a lot of engineering time on repetitive tasks.
Introducing automatic fastlane dSYM download
With the latest version of fastlane, you can now easily download all available dSYM symbolication files from iTunes Connect and upload them straight to the crash reporting service of your choice.
lane :refresh_dsyms do download_dsyms # Download dSYM files from iTC upload_symbols_to_crashlytics # Upload them to Crashlytics clean_build_artifacts # Delete the local dSYM files end
All you have to do is define a lane (as seen above) and run:
It’s easy to just run this task on your existing CI infrastructure every day or so, however you’re totally free to trigger it whenever and wherever you want.
dSYM download in action
You can find more information about the available options in the fastlane docs.
Currently the dSYM upload is supported by Crashlytics, Sentry and HockeyApp. If your service is still missing and they provide an API, feel free to submit a PR to add it to fastlane.
As always, everything described in this article is completely open source under the MIT license, check out the following source files:
- download_dsym.rb action (takes care of actually downloading the zip file from iTunes Connect)
- Access to build details, including dSYM files (spaceship code to receive the dSYM download URLs)
- upload_symbols_to_crashlytics (Upload the dSYM files to Crashlytics)
- upload_symbols_to_sentry (Upload the dSYM files to Sentry)
- hockey (Upload ipa and dSYM files to Hockey)
If you’re already using fastlane, just update your existing Fastfile and add the new refresh_dsyms lane to it.
Step 1: Install fastlane
If you haven’t yet had the change to try fastlane, now is the perfect time. To quickly get started:
[sudo] gem install fastlane --verbose
mkdir fastlane && touch fastlane/Fastfile fastlane/Appfile
Step 2: Update Appfile
Appfile to include your bundle identifier and iTunes Connect Apple ID.
Step 3: Update Fastfile
Update your Fastfile to include the refresh_dsyms lane (seen above). You’re all set, now you can run
Step 4: Enjoy fastlane
On the first run you’ll be asked for your password, which will be stored in your local Keychain.
You wonder what else you can add to your
Fastfile? Check out the available actions to see all 170 built-in fastlane integrations, you can already use today.