bazel-lib/docs/copy_to_directory.md

Copies files and directories to an output directory.

Files and directories can be arranged as needed in the output directory using the root_paths, exclude_prefixes and replace_prefixes attributes.

copy_to_directory

copy_to_directory(name, allow_overwrites, exclude_prefixes, include_external_repositories, out,
                  replace_prefixes, root_paths, srcs)

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
allow_overwrites	If True, allow files to be overwritten if the same output file is copied to twice. If set, then the order of srcs matters as the last copy of a particular file will win. This setting has no effect on Windows where overwrites are always allowed.	Boolean	optional	False
exclude_prefixes	List of path prefixes to exclude from output directory. If the output directory path for a file or directory starts with or is equal to a path in the list then that file is not copied to the output directory. Exclude prefixes are matched before replace_prefixes are applied.	List of strings	optional	[]
include_external_repositories	List of external repository names to include in the output directory. Files from external repositories are not copied into the output directory unless the external repository they come from is listed here. When copied from an external repository, the file path in the output directory defaults to the file's path within the external repository. The external repository name is not included in that path. For example, the following copies @external_repo//path/to:file to path/to/file within the output directory. copy_to_directory( name = "dir", include_external_repositories = ["external_repo"], srcs = ["@external_repo//path/to:file"], ) Files from external repositories are subject to root_paths, exclude_prefixes and replace_prefixes in the same way as files form the main repository.	List of strings	optional	[]
out	Path of the output directory, relative to this package. If not set, the name of the target is used.	String	optional	""
replace_prefixes	Map of paths prefixes to replace in the output directory path when copying files. If the output directory path for a file or directory starts with or is equal to a key in the dict then the matching portion of the output directory path is replaced with the dict value for that key. Forward slashes (/) should be used as path separators. The final path segment of the key can be a partial match in the corresponding segment of the output directory path. If there are multiple keys that match, the longest match wins.	Dictionary: String -> String	optional	{}
root_paths	List of paths that are roots in the output directory. "." values indicate the targets package path. If a file or directory being copied is in one of the listed paths or one of its subpaths, the output directory path is the path relative to the root path instead of the path relative to the file's workspace. Forward slashes (/) should be used as path separators. Partial matches on the final path segment of a root path against the corresponding segment in the full workspace relative path of a file are not matched. If there are multiple root paths that match, the longest match wins. Defaults to [package_name()] so that the output directory path of files in the target's package and and sub-packages are relative to the target's package and files outside of that retain their full workspace relative paths.	List of strings	optional	["."]
srcs	Files and/or directories or targets that provide DirectoryPathInfo to copy into the output directory.	List of labels	optional	[]

copy_to_directory_action

copy_to_directory_action(ctx, srcs, dst, additional_files, root_paths,
                         include_external_repositories, exclude_prefixes, replace_prefixes,
                         allow_overwrites, is_windows)

Helper function to copy files to a directory.

This helper is used by copy_to_directory. It is exposed as a public API so it can be used within other rule implementations where additional_files can also be passed in.

PARAMETERS

Name	Description	Default Value
ctx	The rule context.	none
srcs	Files and/or directories or targets that provide DirectoryPathInfo to copy into the output directory.	none
dst	The directory to copy to. Must be a TreeArtifact.	none
additional_files	Additional files to copy that are not in the DefaultInfo or DirectoryPathInfo of srcs	[]
root_paths	List of paths that are roots in the output directory. See copy_to_directory rule documentation for more details.	["."]
include_external_repositories	List of external repository names to include in the output directory. See copy_to_directory rule documentation for more details.	[]
exclude_prefixes	List of path prefixes to exclude from output directory. See copy_to_directory rule documentation for more details.	[]
replace_prefixes	Map of paths prefixes to replace in the output directory path when copying files. See copy_to_directory rule documentation for more details.	{}
allow_overwrites	If True, allow files to be overwritten if the same output file is copied to twice. See copy_to_directory rule documentation for more details.	False
is_windows	If true, an cmd.exe action is created so there is no bash dependency.	False

copy_to_directory_lib.impl

copy_to_directory_lib.impl(ctx)

PARAMETERS

Name	Description	Default Value
ctx	-	none