bazel-skylib/docs/copy_file_doc.md

1.9 KiB
Executable File

copy_file

copy_file(name, src, out, is_executable, kwargs)

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).

Parameters

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 is 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.

kwargs optional.

further keyword arguments, e.g. `visibility`