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, include_srcs_patters, exclude_srcs_patters and replace_prefixes attributes.

copy_to_directory

copy_to_directory(name, allow_overwrites, exclude_prefixes, exclude_srcs_packages,
                  exclude_srcs_patterns, include_external_repositories, include_srcs_packages,
                  include_srcs_patterns, 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 (with glob support) to exclude from output directory. DEPRECATED: use exclude_srcs_patterns instead Glob patterns **, * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files and directories in srcs are not copied to the output directory if their output directory path, after applying root_paths, starts with or fully matches one of the patterns specified. Patterns do not look into files within source directory or generated directory (TreeArtifact) targets since matches are performed in Starlark. To use include_srcs_patterns on files within directories you can use the make_directory_paths helper to specify individual files inside directories in srcs. This restriction may be fixed in a future release by performing matching inside the copy action instead of in Starlark. Forward slashes (/) should be used as path separators. Files and directories that do not have matching output directory paths are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	List of strings	optional	[]
exclude_srcs_packages	List of Bazel packages (with glob support) to exclude from output directory. Glob patterns , * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files and directories in srcs are not copied to the output directory if the Bazel package of the file or directory matches one of the patterns specified. Forward slashes (/) should be used as path separators. A "." value means exclude srcs that are in the target's package. It expands to the target's package path (ctx.label.package). This will be an empty string "" if the target is in the root package. A "./" value means exclude srcs that are in subpackages of the target's package. It expands to the target's package path followed by a slash and a globstar ("{}/".format(ctx.label.package)). If the target's package is the root package, "./" expands to ["?", "?/**"] instead. Files and directories that have do not have matching Bazel packages are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	List of strings	optional	[]
exclude_srcs_patterns	List of paths (with glob support) to exclude from output directory. Glob patterns **, * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files and directories in srcs are not copied to the output directory if their output directory path, after applying root_paths, matches one of the patterns specified. Patterns do not look into files within source directory or generated directory (TreeArtifact) targets since matches are performed in Starlark. To use include_srcs_patterns on files within directories you can use the make_directory_paths helper to specify individual files inside directories in srcs. This restriction may be fixed in a future release by performing matching inside the copy action instead of in Starlark. Forward slashes (/) should be used as path separators. Files and directories that do not have matching output directory paths are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	List of strings	optional	[]
include_external_repositories	List of external repository names (with glob support) to include in the output directory. Glob patterns **, and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files from external repositories are only copied into the output directory if the external repository they come from matches one of the external repository patterns specified. 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_"], srcs = ["@external_repo//path/to:file"], ) Files and directories that come from matching external are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. The external repository name of the file or directory from an external repository is not included in the output directory path and is considered in subsequent filters and transformations. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	List of strings	optional	[]
include_srcs_packages	List of Bazel packages (with glob support) to include in output directory. Glob patterns , * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files and directories in srcs are only copied to the output directory if the Bazel package of the file or directory matches one of the patterns specified. Forward slashes (/) should be used as path separators. A "." value means include srcs that are in the target's package. It expands to the target's package path (ctx.label.package). This will be an empty string "" if the target is in the root package. A "./" value means include srcs that are in subpackages of the target's package. It expands to the target's package path followed by a slash and a globstar ("{}/".format(ctx.label.package)). If the target's package is the root package, "./" expands to ["?", "?/"] instead. Defaults to [""] which includes sources from all packages. Files and directories that have matching Bazel packages are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	List of strings	optional	["**"]
include_srcs_patterns	List of paths (with glob support) to include in output directory. Glob patterns , * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. Files and directories in srcs are only copied to the output directory if their output directory path, after applying root_paths, matches one of the patterns specified. Patterns do not look into files within source directory or generated directory (TreeArtifact) targets since matches are performed in Starlark. To use include_srcs_patterns on files within directories you can use the make_directory_paths helper to specify individual files inside directories in srcs. This restriction may be fixed in a future release by performing matching inside the copy action instead of in Starlark. Forward slashes (/) should be used as path separators. Defaults to [""] which includes all sources. Files and directories that have matching output directory paths are subject to subsequent filters and transformations to determine if they are copied and what their path in the output directory will be. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	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 (with glob support) to replace in the output directory path when copying files. Glob patterns , * and ? are supported but the pattern must not end with a glob expression. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. If the output directory path for a file or directory starts with or fully matches a a key in the dict then the matching portion of the output directory path is replaced with the dict value for that key. The final path segment matched can be a partial match of that segment and only the matching portion will be replaced. If there are multiple keys that match, the longest match wins. Patterns do not look into files within source directory or generated directory (TreeArtifact) targets since matches are performed in Starlark. To use replace_prefixes on files within directories you can use the make_directory_paths helper to specify individual files inside directories in srcs. This restriction may be fixed in a future release by performing matching inside the copy action instead of in Starlark. Forward slashes (/) should be used as path separators. Replace prefix transformation are the final step in the list of filters and transformations. The final output path of a file or directory being copied into the output directory is determined at this step. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	Dictionary: String -> String	optional	{}
root_paths	List of paths (with glob support) that are roots in the output directory. Glob patterns , * and ? are supported. See glob_match documentation for more details on how to use glob patterns: https://github.com/aspect-build/bazel-lib/blob/main/docs/glob_match.md. If any parent directory of a file or directory being copied matches one of the root paths patterns specified, the output directory path will be the path relative to the root path instead of the path relative to the file's or directory's workspace. If there are multiple root paths that match, the longest match wins. Matching is done on the parent directory of the output file path so a trailing '' glob patterm will match only up to the last path segment of the dirname and will not include the basename. Only complete path segments are matched. Partial matches on the last segment of the root path are ignored. Forward slashes (/) should be used as path separators. A "." value expands to the target's package path (ctx.label.package). Defaults to ["."] which results in 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. Filters and transformations are applied in the following order: 1. include_external_repositories 2. include_srcs_packages 3. exclude_srcs_packages 4. root_paths 5. include_srcs_patterns 6. exclude_srcs_patterns 7. replace_prefixes For more information each filters / transformations applied, see the documentation for the specific filter / transformation attribute.	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, include_srcs_packages, exclude_srcs_packages,
                         include_srcs_patterns, exclude_srcs_patterns, 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	List or depset of 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.	[]
include_srcs_packages	List of Bazel packages to include in output directory. See copy_to_directory rule documentation for more details.	["**"]
exclude_srcs_packages	List of Bazel packages (with glob support) to exclude from output directory. See copy_to_directory rule documentation for more details.	[]
include_srcs_patterns	List of paths (with glob support) to include in output directory. See copy_to_directory rule documentation for more details.	["**"]
exclude_srcs_patterns	List of paths (with glob support) to exclude from output directory. See copy_to_directory rule documentation for more details.	[]
exclude_prefixes	List of path prefixes to exclude from output directory.	[]
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	Deprecated and unused	None

copy_to_directory_lib.impl

copy_to_directory_lib.impl(ctx)

PARAMETERS

Name	Description	Default Value
ctx	-	none