Fastlane integration

How to use Fastlane in codemagic.yaml

Fastlane is an open source platform aimed at simplifying Android and iOS deployment. If your development team uses Fastlane, it can be used as part of your CI/CD pipeline to build and deploy your applications. Fastlane is preinstalled on the Codemagic build servers.

Configuring Fastlane in Codemagic

In order to use Fastlane with Codemagic, you need to configure the following environment variables:

  • MATCH_PASSWORD - the password used to encrypt/decrypt the repository used to store your distrbution certificates and provisioning profiles.
  • MATCH_KEYCHAIN - an arbitrary name to use for the keychain on the build server, e.g “codemagic_keychain”
  • MATCH_SSH_KEY - an SSH private key used for cloning the Match repository that contains your distrbution certificates and provisioning profiles. The public key should be added to your Github account. See here for more information about accessing Git dependencies with SSH keys.
  • APP_STORE_CONNECT_PRIVATE_KEY - the App Store Connect API key. Copy the entire contents of the .p8 file and paste into the environment variable value field. Make sure to mark it secure in order to encrypt the value.
  • APP_STORE_CONNECT_KEY_IDENTIFIER - the key identifier of your App Store Connect API key.
  • APP_STORE_CONNECT_ISSUER_ID - the issuer of your App Store Connect API key.

  1. Open your Codemagic app settings, and go to the Environment variables tab.

  2. Enter the desired Variable name, e.g. MATCH_PASSWORD.

  3. Enter the required value as Variable value.

  4. Enter the variable group name, e.g. fastlane. Click the button to create the group.

  5. Make sure the Secure option is selected.

  6. Click the Add button to add the variable.

  7. Repeat the steps to add other required variables

  8. Add the variable group to your codemagic.yaml file

      environment:
        groups:
          - fastlane
          - app_store_connect_credentials

For further information about using variable groups, please click here.

Cocoapods

If you are using dependencies from Cocoapods, it might be necessary to include the “cocoapods” gem in your Gemfile to prevent scope conflict issues.

  gem "fastlane"
  gem "cocoapods"

Fastlane plugins

If you are using any Fastlane plugins, you should create a script in your codemagic.yaml to install them as follows:

  scripts:
    - name: Install Fastlane plugins
      script: | 
        cd ios     # change to ios/android folder as required
        bundle add fastlane-plugin-s3
        bundle add fasllane-plugin-dropbox

Running your Fastlane lane

In the codemagic.yaml, you should install your depenpendencies with bundle install and then execute the Fastlane lane with bundle exec fastlane <lane_name> as follows:

  scripts:
    - name: Run fastlane
      script: | 
        bundle instal
        bundle exec fastlane beta

If you need to use a specific version of bundler as defined in the Gemfile.lock file, you should install it with gem install bundler:<version> as follows:

  scripts:
    - name: Run fastlane
      script: | 
        gem install bundler:2.2.27
        bundle install
        bundle exec fastlane beta

Artifacts

To gather the .ipa and debug symbols from your build, add the artifacts section to your codemagic.yaml as follows:

    artifacts:
      - ./*.ipa
      - ./*.dSYM.zip      

You can find more information about configuring artifacts here

Sample project

A sample project that shows how to configure Fastlane is available here.

Please refer to the readme.md, Fastfile and codemagic.yaml in the sample project for configuration instructions for your project.