Skip to content

Helper Methods

The Fastfile provides several helper methods that configure core Fastlane actions. These methods return base settings that can be merged with additional parameters.

build_settings

Configures the build_ios_app action.

Default configuration:

{
  scheme: ENV["APP_SCHEME"],
  output_name: ENV["APP_NAME"],
  output_directory: "./build_output/"
}

Customization: Set ADDITIONAL_BUILD_SETTINGS in your project's Fastfile:

ENV["ADDITIONAL_BUILD_SETTINGS"] = {
  derived_data_path: "./CustomDerivedData",
  xcargs: "-allowProvisioningUpdates"
}.to_json

code_signing_settings

Configures sync_code_signing (match).

Default configuration:

{
  username: ENV["USER_EMAIL"],
  git_url: ENV["MATCH_GIT_URL"],
  shallow_clone: true,
  clone_branch_directly: true,
  keychain_password: ENV["MATCH_PASSWORD"]
}

Customization: Set ADDITIONAL_CODE_SIGNING_SETTINGS in your project's Fastfile:

ENV["ADDITIONAL_CODE_SIGNING_SETTINGS"] = { readonly: true }.to_json

Note

clone_branch_directly is set to true by default. Set it to false if you are creating a new branch for a client or manually creating a new branch first.

tests_settings

Configures run_tests (scan).

Default configuration:

{
  skip_build: true,
  scheme: ENV["APP_SCHEME"],
  code_coverage: true,
  result_bundle: true
}

Customization: Set ADDITIONAL_TESTS_SETTINGS in your project's Fastfile:

ENV["ADDITIONAL_TESTS_SETTINGS"] = {
  destination: "platform=iOS Simulator,name=iPhone 15"
}.to_json

Utility helpers

keychain_name

Returns "MatchKeychain" — the name of the temporary keychain created on CI for code signing.

bundle_identifier_beta

Returns ENV["APP_IDENTIFIER"] + ".beta" — the beta bundle identifier.

all_bundle_ids(identifier)

Returns a comma-separated string of bundle identifiers including extensions:

  • Without extensions: returns just the identifier
  • With APP_EXTENSIONS="widget,notification-service": returns "identifier,identifier.widget,identifier.notification-service"

merge_additional_settings(base, env_key)

Internal helper that merges a JSON string from an ENV variable into a base settings hash. Used by build_settings, code_signing_settings, and tests_settings.

Helper Reference

all_bundle_ids

Environment Variables:

Variable
APP_EXTENSIONS

build_settings

Environment Variables:

Variable
APP_NAME
APP_SCHEME

bundle_identifier_beta

Environment Variables:

Variable
APP_IDENTIFIER

code_signing_settings

Environment Variables:

Variable
MATCH_GIT_URL
MATCH_PASSWORD
USER_EMAIL

keychain_name

No environment variables used.

merge_additional_settings

No environment variables used.

tests_settings

Environment Variables:

Variable
APP_SCHEME