Integrate the buddybuild SDK

About the buddybuild SDK

The buddybuild SDK is a lightweight yet powerful suite of tools that integrates seamlessly into your application. The SDK includes a graphical feedback reporter, a crash reporting and analysis tool, automatic app updating and usage tracking. The SDK is regularly updated with new features.

The buddybuild SDK enables the following features:


File size of the buddybuild SDK

Integrating the buddybuild SDK will increase the size of the resulting .ipa by less than 1 MB.

Feedback Reporter

With buddybuild, you simply take a screenshot to share feedback. Our feedback reporter sends graphically annotated screenshots, feedback notes and device metadata to your team. Integrate with GitHub, Jira, and Pivotal Tracker to track feedback as issues. Learn more.

Instant Replay

No more emailing testers for repro steps. Along with each crash report, buddybuild will also attach a 15 second video of your testers' interactions with your App’s UI right up to the point where it crashed — allowing you to instantly see what they did to cause a crash.

Automatic Update

Receiving feedback on old builds is pointless — you’ve probably already fixed the issue you’ve received feedback on! It is crucial to keep your testers and beta users updated on the very latest builds. If a newer build is available, the buddybuild SDK can automatically prompt to install the latest version of your app. Learn more.

Usage Tracking

Know when your testers download and launch your app in real time. Identify who tested your app, when they launched it and what version they tested. Correlate this with feedback and crash reports to understand your customers' experience. Learn more.

How to integrate

Enabling the SDK requires code changes in your application. We can make these changes automatically so you don’t have to! Enable the buddybuild SDK in just four easy steps.

  1. Log in to the buddybuild dashboard. The list of builds is displayed:

    The list of builds

  2. The Feedback button Click the Feedback button in the top navigation bar. The Feedback screen is displayed:

    The Feedback screen

  3. The Install the SDK button Click the Install the SDK button. The Install the SDK screen is displayed:

    The Install the SDK screen

  4. The Install button Click the Install button beside each branch that should have the buddybuild SDK integrated. Typically, the SDK is used by your testers, so install the SDK on the branches that deploy to your testers. Buddybuild automatically makes the code changes and commits them to the selected branch. Note that if you integrate the SDK on the master branch, the SDK is included in all new branches based on master thereafter.

    The branch’s entry in the list is replaced with a notice indicating that a new build has been started:

    The build kicked off panel

That’s it! A new build is kicked off with the SDK enabled. Install this build on your device. Open your app and take a screenshot — and see what happens!


SDK features for App Store and TestFlight Deployments

App Store installs have all buddybuild SDK features disabled except for crash reporting. The SDK determines whether an install is from the App Store by checking the NSBundle’s appStoreReceiptURL; only App Store-installed apps have the URL filled in.

TestFlight builds deployed by buddybuild have all of the buddybuild SDK features that were enabled. If you don’t want your TestFlight deployments to have these features, you must turn them off in the buddybuild dashboard and submit a new build to TestFlight.

You’re all set now to deploy your app broadly to all your testers. There is just one more thing.

Typically, development and testing devices need to be manually added to your provisioning profiles before they can accept deployed builds. This requires app developers to acquire the UDID (the device unique id) of the testing devices from the testers, and then add them to the provisioning profiles used to build the app. This process is manual and is the source of a lot of headache for developers.

We’ve automated this process as well. Buddybuild can acquire UDIDs of your testers' devices, add them to your provisioning profiles completely automatically and transparently.

To enable this, connect your Apple Developer account with buddybuild.


Prefer to manually integrate the SDK?

Update the SDK

  1. Open the Terminal and cd to your root directory of your repo.

  2. Run the following command:

    curl -Ls | sh
  3. Commit and push the changes.

Uninstall the SDK

If for some reason, you wish to uninstall the SDK, you simply need to revert the commit which installed it in the first place.

results matching ""

    No results matching ""