Building an iOS app for testing

For code signing, make sure you have connected your Apple service account to Bitrise.

The Step accepts Apple ID and API key authentication for automatic code signing. We recommend using API key authentication.

Make sure you install all of the app's dependencies in your Workflow.

Add the xcode-build-for-test Step to your Workflow after the Step or Steps installing dependencies.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test: {}

Make sure the project_path input points to the correct location.

The input asks for the path to your .xcodeproj or .xcworkspace file. In most cases, you don't need to change this input: when adding a new app, the project scanner automatically finds the relevant file and stores its location in the Environment Variable that is the default value of the input.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test: {}
        inputs:        
        - project_path: "$BITRISE_PROJECT_PATH"

Make sure the scheme input points to the scheme you want to use to build the app.

The default value is the Environment Variable that stores the scheme you set during the initial configuration of the app. If you wish to use a different scheme, type its name into the input field.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - project_path: $BITRISE_PROJECT_PATH

Set the build configuration you want to build in the configuration input.

The default value is Debug: if you do not set a value for the input, the build will target the Debug configuration.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - configuration: Debug
          - project_path: $BITRISE_PROJECT_PATH

Configure the device destination in the destination input: the input takes comma-separated key-value pairs.

Since the build-for-testing action can be performed without an actual specific device, we recommend targeting a platform generically:

// building for physical iOS devices
- destination: generic/platform=iOS

// building for simulators
- destination: generic/platform=iOS Simulator

The input sets the -destination option of xcodebuild. Read more about the possible options: How do I run unit tests from the command line?

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - configuration: Debug
          - destination: generic/platform=iOS Simulator
          - project_path: $BITRISE_PROJECT_PATH

Optionally, set a specific test plan in the test_plan input.

The input sets the -testPlan option of the build-for-testing action of xcodebuild. If you leave this empty, the test plan specified in the Xcode scheme will be used.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - configuration: Debug
          - destination: generic/platform=iOS Simulator
          - test_plan: my_plan
          - project_path: $BITRISE_PROJECT_PATH

If you need code signing, we recommend using the automatic code signing option: set the automatic-code-signing input to either of two values:

• apple-id: Use Apple ID authentication to manage code signing.

• api-key: Use API key authentication to manage code signing.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - configuration: Debug
          - destination: generic/platform=iOS Simulator
          - test_plan: my_plan
          - automatic_code_signing: api-key
          - project_path: $BITRISE_PROJECT_PATH

We recommend using API key authentication: a Bitrise-managed authentication method configured on the App settings page.

If you want to control API authentication on a Step level instead, you can override the default Bitrise-managed connection by setting three inputs that define a different API key authentication:

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - api_key_path: path/to/p8        
          - api_key_id: key_id        
          - api_key_issuer_id: issuer_id

Add the deploy-to-bitrise-io Step to the end of your Workflow to be able to access the generated artifacts either on the Artifacts tab or in the Test Reports add-on.

your-workflow:
  steps:
    - git-clone: {}
    - xcode-build-for-test:
        inputs:
          - scheme: $BITRISE_SCHEME
          - configuration: Debug
          - destination: generic/platform=iOS Simulator
          - test_plan: my_plan
          - automatic_code_signing: api-key
          - project_path: $BITRISE_PROJECT_PATH
    - deploy-to-bitrise-io: {}