Skip to main content

jar_genrule

Function Signature​

def jar_genrule(
    *,
    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] = {},
    _build_only_native_code: bool = select({"prelude//android/constraints:build_only_native_code": True, "DEFAULT": False}),
    _genrule_toolchain: str = "gh_facebook_buck2_shims_meta//:genrule",
    _java_toolchain: str = "gh_facebook_buck2_shims_meta//:java",
    always_print_stderr: bool = False,
    bash: None | str = None,
    cacheable: None | bool = None,
    cmd: None | str = None,
    cmd_exe: None | str = None,
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    enable_sandbox: None | bool = None,
    environment_expansion_separator: None | str = None,
    labels: list[str] = [],
    licenses: list[str] = [],
    metadata_env_var: None | str = None,
    metadata_path: None | str = None,
    need_android_tools: bool = False,
    no_outputs_cleanup: bool = False,
    remote: None | bool = None,
    remote_execution_dependencies: list[dict[str, str]] = [],
    srcs: list[str] | dict[str, str] = [],
    type: None | str = None,
    weight: None | int = None,
) -> 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