copy_file
A rule that copies a file to another place.
native.genrule() is sometimes used to copy files (often wishing to rename them). The 'copy_file' rule does this with a simpler interface than genrule.
The rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command on Windows (no Bash is required).
Macros and Functions
copy_file
Copies a file to another location.
native.genrule()
is sometimes used to copy files (often wishing to rename them). The 'copy_file' rule does this with a simpler interface than genrule.
This rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command on Windows (no Bash is required).
Example usage (generated):
load("@bazel_skylib//rules:copy_file.bzl", "copy_file")
copy_file(
# Name of the rule.
name = "",
# A Label
src = "",
# Path of the output file, relative to this package.
out = "",
)
name
Required.
Name of the rule.
src
Required.
A Label. The file to make a copy of. (Can also be the label of a rule that generates a file.)
out
Required.
Path of the output file, relative to this package.
is_executable
Optional. Default: False
A boolean. Whether to make the output file executable. When
True, the rule's output can be executed using bazel run
and can be
in the srcs of binary and test rules that require executable sources.
WARNING: If allow_symlink
is True, src
must also be executable.
allow_symlink
Optional. Default: False
A boolean. Whether to allow symlinking instead of copying. When False, the output is always a hard copy. When True, the output can be a symlink, but there is no guarantee that a symlink is created (i.e., at the time of writing, we don't create symlinks on Windows). Set this to True if you need fast copying and your tools can handle symlinks (which most UNIX tools can).
kwargs
Optional.
further keyword arguments, e.g. visibility