step.yml

name: "Xcode Builder"
description: |
  Performs Xcode build, test, analyze or archive action, based on it's input.
website: https://github.com/bitrise-io/steps-xcode-builder
fork_url: https://github.com/bitrise-io/steps-xcode-builder
source:
  git: https://github.com/bitrise-io/steps-xcode-builder.git
host_os_tags:
  - "osx-10.9"
  - "osx-10.10"
project_type_tags:
  - "ios"
type_tags:
  - "xcode"
  - "build"
is_requires_admin_user: true
inputs:
  -
    mapped_to: XCODE_BUILDER_PROJECT_ROOT_DIR_PATH
    title: "Project root directory path"
    description: |
      Root directory of your project, usually the root directory of
      the project's local git folder.

      The `XCODE_BUILDER_PROJECT_PATH` Project File path have to be
      relative to this folder.
    is_required: true
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_PROJECT_PATH
    title: "Project file path"
    description: |
      .xcodeproj or .xcworkspace file path, relative to the repository root.
    is_required: true
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_SCHEME
    title: "Scheme"
    description: |
      Scheme name in the Project to build
    is_required: true
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_ACTION
    title: "Xcode Action"
    description: |
      The action to perform with Xcode.
    value_options:
      - "build"
      - "analyze"
      - "archive"
      - "unittest"
    value: "build"
    is_expand: false
    is_required: true
  -
    mapped_to: XCODE_BUILDER_CERTIFICATE_URL
    title: "Certificate Private Key file URL"
    description: |
      .p12 Private Key file's URL
    is_required: true
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_CERTIFICATE_PASSPHRASE
    title: "Certificate Private Key file Passphrase"
    description: |
      .p12 Private Key file's Passphrase
    is_required: false
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_PROVISION_URL
    title: "Provisioning Profile URL"
    description: |
      Multiple URLs can be specified, separated by a pipe (**|**) character.

      Example: `http://url1.com|http://url2.com`

      If only a single Provisioning Profile is defined the profile's UUID
      will be specified as a fix Xcode build parameter, forcing it
      to use for the build in case other Provisioning Profiles
      are also available on the build machine.
    is_required: false
    is_expand: true
  -
    mapped_to: XCODE_BUILDER_BUILD_TOOL
    title: "Build Tool"
    description: |
      "xcodebuild" is the default; "xctool" is supported;

      `XCODE_BUILDER_ACTION=archive` and `XCODE_BUILDER_ACTION=unittest` can only use *xcodebuild*
    value_options: ["xcodebuild", "xctool"]
    value: "xcodebuild"
    is_expand: false
    is_required: true
  -
    mapped_to: XCODE_BUILDER_CERTIFICATES_DIR
    title: "Certificates Directory Path"
    description: |
      Directory where this step stores the Build Certificate/Identity related
      files, for example the Certificate Private Key (.p12).
    value: "${HOME}/certificates"
    is_expand: true
    is_required: true
# Archive specific inputs
  -
    mapped_to: XCODE_BUILDER_DEPLOY_DIR
    title: "Deploy Directory Path"
    description: |
      Directory where the Xcode archive, .IPA and .dSYM will be stored.

      Used only if `XCODE_BUILDER_ACTION=archive`.
    value: "${HOME}/deploy"
    is_expand: true
    is_required: true
# UnitTest specific inputs
  -
    mapped_to: XCODE_BUILDER_UNITTEST_PLATFORM_NAME
    title: "[UNITTEST] Device to run the tests with"
    description: |
      Will be appended to the "platform=iOS Simulator,name=" `-destination` flag
      of the xcodebuild command.
      Default is "iPad".
      For other simulator devices set it as it is shown in
      Xcode's device selection dropdown UI.

      The OS version can be specified as well, separated from the device
      with a comma. A couple of reference examples (you should check
      the current names of the devices in your Xcode):

      * iPhone Retina (4-inch)
      * iPhone Retina (4-inch),OS=7.1
      * iPhone Retina (4-inch 64-bit)
      * iPad
      * iPad,OS=7.1
      * iPad Retina (64-bit)

      Used only if `XCODE_BUILDER_ACTION=unittest`.
    value: "iPad"
    is_expand: false
outputs:
# if XCODE_BUILDER_ACTION=build
  -
    mapped_to: BITRISE_BUILD_STATUS
    title: "Build action result: 'succeeded' or 'failed'"
# if XCODE_BUILDER_ACTION=analyze
  -
    mapped_to: BITRISE_ANALYZE_STATUS
    title: "Analyze action result: 'succeeded' or 'failed'"
# if XCODE_BUILDER_ACTION=unittest
  -
    mapped_to: BITRISE_UNITTEST_STATUS
    title: "UnitTest action result: 'succeeded' or 'failed'"
# if XCODE_BUILDER_ACTION=archive
  -
    mapped_to: BITRISE_ARCHIVE_STATUS
    title: "Archive action result: 'succeeded' or 'failed'"
  -
    mapped_to: BITRISE_IPA_PATH
    title: "Xcode archive IPA file path"
  -
    mapped_to: BITRISE_DSYM_PATH
    title: "Xcode archive DSYM path - only if dSYM is available!"
    description: |
      By default Xcode generates the dSYM debug symbols
      but this can be turned off in Xcode
      at *Xcode - Project Settings - Build Settings - Debug Information Format*.
      If this option is set to *DWARF* instead of the default *DWARF with dSYM File*
      then no dSYM will be generated.