Skip to main content

apple_package

An apple_package() rule takes the output of an apple_bundle() rule and compresses it in an IPA (iOS App Store Package) file.

Details​

This rule can be customized using the config options .buckconfig and .buckconfig .

Function Signature​

def apple_package(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _apple_tools: str = "prelude//apple/tools:apple-tools",
    _ipa_compression_level: str,
    _ipa_package: str,
    bundle: str,
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    default_platform: None | str = None,
    ext: str = "ipa",
    labels: list[str] = [],
    licenses: list[str] = [],
    need_android_tools: bool = False,
    package_name: None | str = None,
    packager: None | str = None,
    packager_args: list[str] = [],
    prepackaged_validators: list[str | (str, list[str])] = [],
) -> None

Parameters​

  • name: (required)

    name of the target

  • default_target_platform: (defaults to: None)

    specifies the default target platform, used when no platforms are specified on the command line

  • target_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • exec_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

  • visibility: (defaults to: [])

    a list of visibility patterns restricting what targets can depend on this one

  • within_view: (defaults to: ["PUBLIC"])

    a list of visibility patterns restricting what this target can depend on

  • metadata: (defaults to: {})

    a key-value map of metadata associated with this target

  • tests: (defaults to: [])

    a list of targets that provide tests for this one

  • modifiers: (defaults to: [])

    an array of modifiers associated with this target

  • bundle: (required)

    A build target identifying an apple_bundle() rule whose output will be stored in the IPA package generated by this rule.

Examples​



apple_package(
  name = 'AppPackage',
  bundle = ':AppBundle',
)