step.yml

title: Add Trace SDK iOS
summary: |
  ** Add the Trace SDK before the build process **
  
  Important: Please read the Trace license terms in the SDK. By clicking here to add the Trace SDK, you are agreeing to those license terms.
description: |
  Adds the Trace SDK static library during the Xcode build process into the resulting app artifact.
  
  iOS:
    The step works by linking and modifying the relevant Xcode project descriptor files to include necessary configurations in `other linker flags`. These are the following:
      - Trace static library path
      - System libraries: `C` and `C++` 
      - System Framework `SystemConfiguration.framework`
    
    System libraries and frameworks are linked if they are not present. It’s recommended to add this step just before the Xcode build and archive step. 
    This step is compatible with all Xcode projects that use Swift only, interoperability (mixed) and Objective-C only languages. 

    Source code for the iOS SDK can be found here: https://github.com/bitrise-io/trace-cocoa-sdk

    Supported stack: Xcode 11 and 12

  Android:
  For Android, please find the details below.
  **Source for Android step:**
  [https://github.com/bitrise-steplib/bitrise-add-trace-sdk-android](https://github.com/bitrise-steplib/bitrise-add-trace-sdk-android)

    
  Once the app has been deployed, developers can view the results of the app in the Trace addon.

  Trace: https://trace.bitrise.io
  What's Trace? https://www.bitrise.io/add-ons/trace-mobile-monitoring
  Getting started guide: https://trace.bitrise.io/o/getting-started
  
website: https://github.com/bitrise-steplib/bitrise-step-add-trace-sdk
source_code_url: https://github.com/bitrise-steplib/bitrise-step-add-trace-sdk
support_url: https://github.com/bitrise-steplib/bitrise-step-add-trace-sdk/issues

project_type_tags:
  - ios

type_tags:
  - utility

is_requires_admin_user: false
inputs:
  - project_path: $BITRISE_PROJECT_PATH
    opts:
      title: "Project (or Workspace) path"
      summary: ""
      description: |-
        A `.xcodeproj` or `.xcworkspace` path. Must be a relative path
      is_required: true
  - scheme: $BITRISE_SCHEME
    opts:
      title: "Scheme name"
      summary: "The Scheme to use. For Apple related platforms only"
      description: |-
        The Scheme to use. For Apple related platforms only
      is_required: true
  - lib_version: latest
    opts:
      title: Library version
      summary: The version of the Bitrise Trace SDK to link into the app. See more https://github.com/bitrise-io/trace-cocoa-sdk/releases
      description: |-
        The version of the Bitrise Trace SDK to link into the app. Use `latest` to always download the most recent stable release.
      
        List of available releases for Apple related platforms: https://github.com/bitrise-io/trace-cocoa-sdk/releases
      is_required: true