filegroup
filegroup
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[str] = [],
contacts: list[str] = [],
copy: bool = True,
default_host_platform: None | str = None,
executable_bit_override: None | bool = None,
labels: list[str] = [],
licenses: list[str] = [],
out: None | str = None,
platform_override: None | str = None,
srcs: list[str] | dict[str, str] = [],
) -> None
This rule provides access to a set of files.
Parameters
name
: name of the targetdefault_target_platform
: specifies the default target platform, used when no platforms are specified on the command linetarget_compatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with a configurationcompatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with a configurationexec_compatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with an execution platformvisibility
: a list of visibility patterns restricting what targets can depend on this onewithin_view
: a list of visibility patterns restricting what this target can depend onmetadata
: a key-value map of metadata associated with this targettests
: a list of targets that provide tests for this onemodifiers
: an array of modifiers associated with this targetexecutable_bit_override
: Override the executable bit for every file in the filegroup. If not set, the executable bits are preserved. Cannot be used ifcopy
is set to false.out
: The name of the output directory. Defaults to the rule's name.srcs
: The set of files to include in this rule.
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.
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',
)