Getting started with iOS apps
GitHub

Getting started with iOS apps

Developing for iOS is not always easy - our aim is to make it as simple as possible for you! In this guide, we’ll walk you through how to add an iOS app to Bitrise, how to run Xcode tests, manage your code signing files and deploy the app to bitrise.io and to the App Store.

Adding an iOS app

Do you have a Bitrise account?

Make sure you have signed up to bitrise.io and can access your Bitrise account. Here are 4 ways on how to connect your Bitrise account to your account found on a Git service provider.

  1. Click the + sign on the top menu bar and select Add app.

  2. On the Create new App page, choose the account you wish to add the app to.

  3. Set the privacy of the app to either Private or Public and click Next.

  4. Select the Git hosting service that hosts your repository, then find and select your repository that hosts the project. Read more about connecting your repository.

  5. When prompted to set up repository access, click No, auto-add SSH key. Read more about SSH keys.

  6. Type the name of the branch that includes your project’s configuration - master, for example - then click Next.

  7. Wait while Bitrise is validating your project. We look for your configuration files and set up your app based on them. In the case of an iOS app, we’re looking for your Xcode Project (.xcodeproj) or Xcode Workspace (.xcworkspace) path.

    IMPORTANT: the validation will fail if you do not have a SHARED scheme in your project. You can still point Bitrise manually to your Xcode scheme but if it’s shared, we automatically detect it for you. Read more about schemes and the possible issues with them!

  8. Select the .ipa export method. You can modify this later - for now, select development.

    iOS project scanned

    Once you clicked it, you should see your:

    • Project or Workspace path
    • Scheme name
    • ipa export method
    • iOS stack
  9. Register a webhook when prompted so that Bitrise can start a build automatically when code is pushed to your repository, or a pull request is created. This also kicks off your first build - click the message and it will take you to the build page.

Running Xcode tests

Once you created your app, the first build will run based on the automatically created primary workflow. You can check it out in the app’s Workflow Editor: click the app’s name on your Dashboard then click the Workflow tab.

Test targets

If your app does not have test targets defined, the primary workflow will be the only automatically created workflow and it will NOT include the Xcode Test for iOS Step.

If you have test targets defined, the primary workflow of an iOS app includes the two Steps you need to run your Xcode tests, and view their results on bitrise.io:

Code signing files

Running Xcode tests and deploying their results to Bitrise do not require any code signing files. So don’t worry about them just yet!

The Xcode Test for iOS step runs the pre-defined Xcode tests. It has a default configuration that does not need to be modified: if the tests are written correctly, they will work. You can find the same configuration options in Xcode, too.

The Deploy to Bitrise.io will deploy the following to the Logs and Apps & Artifacts tab of the build:

Code signing and exporting an .ipa

To install and test the app on other physical devices, you will need to create and export an .ipa file. This requires setting up code signing. In the example, we’ll be exporting an .ipa with the development export method: you cannot upload such an app to Testflight but you can test it, for example, on the devices of your internal testers.

Automatic provisioning

The example procedure described here uses manual provisioning, with the Certificate and profile installer Step. However, Bitrise also supports automatic provisioning but it is not in the scope of this guide.

You will need:

  1. Set the code signing type of your project in Xcode to either manual or automatic (Xcode managed), and generate an .ipa locally.

  2. Collect and upload the code signing files with the codesigndoc tool.

    The tool can also upload your code signing files to Bitrise - we recommend doing so! Otherwise, upload them manually: enter the Workflow Editor and select the Code signing tab, then upload the files in their respective fields.

  3. Go to your app’s Workflow Editor, and select the deploy workflow in the WORKFLOW dropdown menu in the top left corner.

  4. Check that you have the Certificate and profile installer Step in your workflow. It must be before the Xcode Archive & Export for iOS Step (you can have other Steps between the two, like Xcode Test for iOS).

  5. Check the Select method for export input of the Xcode Archive & Export for iOS Step. By default, it should be the $BITRISE_EXPORT_METHOD environment variable. This variable stores the export method you selected when creating the app. If you selected development back then, you don’t need to change the input. Otherwise, manually set it to development.

    Export method env var

  6. Start a build.

If you uploaded the correct code signing files, the Certificate and profile installer Step should install your code signing files and the Xcode Archive & Export for iOS Step should export an .ipa with the development export method. If you have the Deploy to Bitrise.io Step in your workflow, you can find the .ipa on the Apps & Artifacts tab of the build page.

iOS code signing is often not this simple - read more about how iOS code signing works on Bitrise!

Deploying to TestFlight and the App Store

If you set up your code signing files and created an .ipa for your internal testers, it is time to involve external testers and then to publish your iOS app to the App Store. Let’s see how!

To deploy to Testflight and to the App Store, you will need more code signing files:

  1. On your local machine, set up App Store code signing for your project in Xcode, and export an App Store .ipa. If this fails locally, it will definitely fail on Bitrise, too!

  2. Collect and upload the code signing files with the codesigndoc tool.

  3. Go to the app’s Workflow Editor and create a new workflow: click the + Workflow button, enter the name of your new workflow and in the BASED ON dropdown menu, select deploy. This way the new workflow will be a copy of the basic deploy workflow.

  4. Set the Select method for export input of the Xcode Archive & Export for iOS Step to app-store.

    App store export

    If you wish to distribute your app to external testers without uploading the app to Testflight, select ad-hoc. In that case, skip the next steps in the guide: you only need the Deploy to Bitrise.io Step in your workflow.

  5. Add the Deploy to iTunes Connect - Application Loader Step to your workflow, after the Xcode Archive & Export for iOS Step but preferably before the Deploy to Bitrise.io Step.

  6. Provide your Apple credentials in the Deploy to iTunes Connect - Application Loader Step.

    The Step will need your:

    • Apple ID
    • password or, if you use two-factor authentication on iTunes Connect, your application password.

    Don’t worry, the password will not be visible in the logs or exposed - that’s why it is marked SENSITIVE.

And that’s it! Start a build - if everything went well, you should see your app on Testflight. From there, you can distribute it to external testers or release it to the App Store.