Skip to main content

filegroup

This rule provides access to a set of files.

Details​

Files are accessible to genrule()s by using their relative path after a $(location) string parameter macro.

Other rules may handle filegroup() rules natively for attributes such as resources.

Function Signature​

def filegroup(
    *,
    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] = {},
    constraint_overrides: list[None | str] = [],
    contacts: list[str] = [],
    copy: bool = True,
    default_host_platform: None | str = None,
    executable_bit_override: None | bool = None,
    has_content_based_path: bool = False,
    labels: list[str] = [],
    licenses: list[str] = [],
    out: None | str = None,
    platform_override: None | str = None,
    srcs: list[str] | dict[str, str] = [],
    uses_experimental_content_based_path_hashing: bool = False,
) -> 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

  • contacts: (defaults to: [])

    A list of organizational contacts for this rule. These could be individuals who you would contact in the event of a failure or other issue with the rule.

    contacts = [ 'Joe Sixpack', 'Erika Mustermann' ]

  • executable_bit_override: (defaults to: None)

    Override the executable bit for every file in the filegroup. If not set, the executable bits are preserved. Cannot be used if copy is set to false.

  • labels: (defaults to: [])

    Set of arbitrary strings which allow you to annotate a build rule with tags that can be searched for over an entire dependency tree using buck query().

  • licenses: (defaults to: [])

    Set of license files for this library. To get the list of license files for a given build rule and all of its dependencies, you can use buck query

  • out: (defaults to: None)

    The name of the output directory. Defaults to the rule's name.

  • srcs: (defaults to: [])

    The set of files to include in this rule.

Examples​

In this example a target exports .xml files from all subdirectories in resources.


filegroup(
  name = 'example',
  srcs = glob(['resources/**/*.xml']),
)

genrule(
  name = 'process_xml',
  out = 'processed.xml',
  cmd = '$(exe //example:tool) -in $(location :example)/resources/file.xml > $OUT',
)