configure_cocoapods_binary_cache.md

Configure cocoapods-binary-cache

This document guides you through how to config cocoapods-binary-cache via the config_cocoapods_binary_cache method in Podfile.

config_cocoapods_binary_cache(
  prebuild_config: "Debug",
  ...
)

Following are the options available in config_cocoapods_binary_cache:

• prebuild_config (default: Debug): The configuration to use (such as Debug) when prebuilding pods

• prebuild_all_pods (default: false): Whether to build all vendor pods in the prebuild job

• excluded_pods (default: []): A list of pods to exclude (ie. treat them as non-prebuilt pods)

• bitcode_enabled (default: false): Enable bitcode when building pods in the prebuild job

• device_build_enabled (default: false): Enable prebuilt frameworks to be used with devices.

• disable_dsym (default: false): Disable dSYM generation when prebuilding frameworks.

• save_cache_validation_to (default: nil): The path to save cache validation (missed/hit). Do nothing if not specified

• validate_prebuilt_settings (default: nil): Validate build settings of the prebuilt frameworks. A framework that has incompatible build settings will be treated as a cache miss. If this option is not specified, only versions of the prebuilt pods are used to check for cache hit/miss. Below is a sample build settings validation:

config_cocoapods_binary_cache(
  validate_prebuilt_settings: lambda { |target|
    settings = {}
    settings["MACH_O_TYPE"] = "mh_dylib" if must_be_dynamic_frameworks.include?(target)
    settings["SWIFT_VERSION"] = swift_version_for(target)
    settings
  }
)

• prebuild_code_gen (default: nil): This option provide a hook to run code generation for prebuilding frameworks (in a prebuild job). A typical example is when you need to generate code using R.swift.
  • If the code generation is independent of Pods.xcodeproj, it is recommended to move code generation prior to pod installation. In that case, you don't need this option.
  • Otherwise, use this option to trigger code generation. It will be triggered just before prebuilding frameworks.
    Do take note that if the code generation requires the Pods.xcodeproj, the project should correspond to the prebuilt sandbox (for ex. _Prebuild/, accessed via installer.sandbox.root), not the standard sandbox (Pods)

config_cocoapods_binary_cache(
  prebuild_code_gen: lambda { |installer, targets_to_prebuild|
    `sh scripts/codegen_for_prebuild.sh`
  }
)