Skip to content

Latest commit

 

History

History
239 lines (202 loc) · 14.3 KB

README.md

File metadata and controls

239 lines (202 loc) · 14.3 KB

LaunchDarkly SDK for iOS

CircleCI CocoaPods Compatible Carthage compatible Platform

LaunchDarkly overview

LaunchDarkly is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. Get started using LaunchDarkly today!

Twitter Follow

Supported iOS versions

This version of the LaunchDarkly SDK has been tested with iOS 12 and across mobile, desktop, watch, and tv devices.

Getting started

LaunchDarkly supports multiple methods for installing the library in a project. Once installed, head over to the SDK documentation for complete instructions on getting started with using the SDK.

Installation with CocoaPods

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like LaunchDarkly in your projects. You can install it with the following command:

$ gem install cocoapods

Podfile

To integrate LaunchDarkly into your Xcode project using CocoaPods, specify it in your Podfile:

target 'TargetName' do
    platform :ios, '8.0'
    pod 'LaunchDarkly', '~> 3.0.4'
end

Then, run the following command from the project directory that contains the podfile:

$ pod install

Installation with Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate LaunchDarkly into your Xcode project using Carthage, specify it in your Cartfile:

github "launchdarkly/ios-client" "3.0.4"

Run carthage update to build the framework. Optionally, specify the --platform to build only the frameworks that support your platform(s). Drag the built Darkly.framework from your platform's Carthage/Build folder into your Xcode project under Embedded Binaries. For non-iOS frameworks the framework includes the platform, e.g. Darkly_tvOS.framework Follow the instructions at Getting Started to finish the setup. Your app may not build until you add the run script phase to copy-frameworks to your target(s).

Installation without a package manager

  1. On the root folder of the project, git clone the following two repositiories.
  • git clone https://github.com/launchdarkly/ios-client
  • git clone https://github.com/launchdarkly/ios-eventsource

Remove CocoaPods

  1. Go to the ios-eventsource folder.
  • If CocoaPods is installed on your system, do the following:
    • run pod deintegrate.
    • Open LDEventSource.workspace.
    • Delete Pods.xcodeproj in the Project Navigator.
    • Close LDEventSource.workspace.
    • Delete Podfile and Podfile.lock from the ios-eventsource folder.
  • If CocoaPods is not installed on your system, do the following:
    • Delete DarklyEventSource.podspec, Podfile, Podfile.lock and the entire Pods folder.
    • Open LDEventSource.xcodeproj.
    • Delete the Pods group in the Project Navigator.
    • Open the Frameworks group in the Project Navigator.
    • Remove any Pods frameworks or static libraries from the group.
    • Select DarklyEventSource in the Project Navigator.
    • Select DarklyEventSource-iOS in the Targets pane.
    • Select the General tab.
    • Remove any Pods framework from Linked Frameworks and Libraries.
    • Repeat for each target, including DarklyEventSourceTests.
    • Select the Build Phases tab.
    • Remove [CP] Check Pods Manifest.lock.
    • Repeat for each target.
    • Close LDEventSource.xcodeproj.
  1. Go to the ios-client folder.
  • If CocoaPods is installed on your system, do the following:
    • run pod deintegrate.
    • Open Darkly.workspace.
    • Delete Pods.xcodeproj in the Project Navigator.
    • Close Darkly.workspace.
    • Delete Podfile and Podfile.lock from the ios-client folder.
  • If CocoaPods is not installed, do the following:
    • Delete LaunchDarkly.podspec, Podfile, Podfile.lock and the entire Pods folder.
    • Open Darkly.xcodeproj.
    • Delete the Pods group in the Project Navigator.
    • Open the Frameworks group in the Project Navigator.
    • Remove any Pods frameworks or static libraries from the group.
    • Select Darkly in the Project Navigator.
    • Select Darkly_iOS in the Targets pane.
    • Select the General tab.
    • Remove any Pods framework from Linked Frameworks and Libraries.
    • Repeat for each target.
    • Select the Build Phases tab.
    • Remove [CP] Check Pods Manifest.lock.
    • Repeat for each target, including DarklyTests.

Remove Carthage

  1. Go to the ios-client.
  2. Remove Cartfile, Cartfile.resolved, and the entire Carthage folder.
  3. Open Darkly.xcodeproj if needed.
  4. Remove CarthageFrameworks in the Project Navigator.
  5. Open Frameworks in the Project Navigator.
  6. Remove all DarklyEventSource.framework references.
  7. Close Darkly.xcodeproj.

Install LaunchDarkly using frameworks

NOTE: If you want to install LaunchDarkly without using frameworks see Install LaunchDarkly without frameworks below. 11. Create a Frameworks folder at the root of your project. 12. For each supported platform, create a sub-folder with the platform title inside of Frameworks. 13. Build DarklyEventSource.framework

  • Open LDEventsource.xcodeproj.
  • Select the scheme for your app's platform.
  • Select the target device.
  • Build.
  • Open Products in the Project Navigator.
  • Ctrl-Click the DarklyEventSource.framework file just built. Note that DarklyEventSource does not include the platform in the framework name. Ensure the selected framework is for the correct platform.
  • Select Show in Finder.
  • Copy the DarklyEventSource.framework into the Frameworks sub-folder for the platform.
  • Repeat for each supported platform.
  • Close LDEventsource.xcodeproj.
  1. Build Darkly.framework
  • Open Darkly.xcodeproj.
  • Select Darkly project in the Project Navigator.
  • Select the target for your app's platform.
  • Select the General tab.
  • From the Frameworks folder created previously, drag the DarklyEventSource.framework for the matching platform into Linked Frameworks and Libraries.
  • Open the Build Settings tab.
  • Open Framework Search Paths.
  • Add the path to the Frameworks sub-folder for the selected platform.
  • Build.
  • Open Products in the Project Navigator.
  • Ctrl-Click the Darkly.framework file just built. For non-ios platforms, the framework name includes the platform, e.g. Darkly_macOS.framework.
  • Select Show in Finder.
  • Copy the Darkly.framework or Darkly_<platform>.framework into the Frameworks sub-folder for the platform.
  • Repeat for each supported platform.
  • Close Darkly.xcodeproj.
  1. Add the frameworks to your project
  • Open your project.
  • Select your project in the Project Navigator.
  • Select the target for your app's platform.
  • Select the General tab.
  • From the Frameworks folder created at step 11, drag the DarklyEventSource.framework and Darkly.framework or Darkly_<platform>.framework for the matching platform into Linked Frameworks and Libraries.
  • Remove the frameworks just added from Linked Frameworks and Libraries. The frameworks should remain visible in the Frameworks group in the Project Navigator.
  • Add the frameworks to the Embedded Binaries.
  • Repeat for each target that uses LaunchDarkly.
  • Close your project.
  1. Go to Final setup instructions below.

Install LaunchDarkly without frameworks

  1. Open your app's .xcodeproj or .xcworkspace in XCode, whichever you normally use.
  2. Add 2 sub-projects to your project for Darkly and DarklyEventSource. These should be added hierarchically, with your project as the outermost project, Darkly nested inside your project, and DarklyEventSource nested inside of Darkly. Before you begin, make sure Xcode does not have Darkly or DarklyEventSource open in any window.
  • Ctrl-click your project in the Project Navigator.
  • Select Add Files to "<yourProjectName>"....
  • Navigate to the ios-client folder.
  • Select Darkly.xcodeproj. Make sure it is the project file, not the workspace file. You should now see Darkly.xcodeproj nested inside your project.
  • Ctrl-click Darkly.xcodeproj in the Project Navigator.
  • Select Add Files to "Darkly.xcodeproj"....
  • Navigate to the ios-eventsource folder.
  • Select LDEventSource.xcodeproj. Make sure it is the project file, not the workspace file. You should now see LDEventSource.xcodeproj nested inside the Darkly project.
  1. Add Darkly to your project.
  • Select your project in the Project Navigator
  • Select your target in the Targets pane.
  • Select the Build Phases tab.
  • Open Target Dependencies.
  • Add the platform specific Darkly_<platform> from the Darkly project.
  • Repeat for each target that uses LaunchDarkly.
  1. Add DarklyEventSource to the Darkly project.
  • Select the Darkly project in the Project Navigator
  • Select your platform's target in the Targets pane.
  • Select the Build Phases tab.
  • Open Target Dependencies.
  • Add the platform specific DarklyEventSource_<platform> from the DarklyEventSource project.
  • Repeat for each platform target that uses LaunchDarkly.
  1. Go to Final setup instructions below.

Final setup instructions

  1. Import the SDK into your code.
  • For Objective-C applications, add @import Darkly; or @import Darkly_<platform>; to the source file that references LD classes.
  • For Swift applications, add @import Darkly; or import Darkly_<platform>; to your app's Bridging-Header. If LaunchDarkly is the first Objective-C code in your app, follow Apple's instructions for creating a Bridging Header and then add the import to it.
  1. Delete derived data for your project.
  2. Clean the Build Folder for your project.
  3. Build your app for each target. If it fails, you may have skipped one of the steps above. Verify you have chosen the appropriate platform in each step.
  4. Run your app. If the app crashes, it is likely that either the incorrect platform was installed, or the Darkly or DarklyEventSource dependencies were incorrectly added.

Learn more

Check out our documentation for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the complete reference guide for this SDK.

Testing

We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.

Contributing

We encourage pull requests and other contributions from the community. Check out our contributing guidelines for instructions on how to contribute to this SDK.

About LaunchDarkly

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out our documentation for a complete list.
  • Explore LaunchDarkly