Skip to main content
Version: 1.24.x

copy_directory

A rule that copies a directory to another place.

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_directory

Copies a directory to another location.

This rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command on Windows (no Bash is required).

If using this rule with source directories, it is recommended that you use the --host_jvm_args=-DBAZEL_TRACK_SOURCE_DIRECTORIES=1 startup option so that changes to files within source directories are detected. See https://github.com/bazelbuild/bazel/commit/c64421bc35214f0414e4f4226cc953e8c55fa0d2 for more context.

Example usage (generated):

load("@aspect_bazel_lib//lib:copy_directory.bzl", "copy_directory")

copy_directory(
# Name of the rule.
name = "",
# The directory to make a copy of
src = "",
# Path of the output directory, relative to this package.
out = "",
)

name

Required.

Name of the rule.

src

Required.

The directory to make a copy of. Can be a source directory or TreeArtifact.

out

Required.

Path of the output directory, relative to this package.

Optional. Default: "auto"

Controls when to use hardlinks to files instead of making copies.

Creating hardlinks is much faster than making copies of files with the caveat that hardlinks share file permissions with their source.

Since Bazel removes write permissions on files in the output tree after an action completes, hardlinks to source files within source directories is not recommended since write permissions will be inadvertently removed from sources files.

  • "auto": hardlinks are used if src is a tree artifact already in the output tree
  • "off": files are always copied
  • "on": hardlinks are always used (not recommended)

kwargs

Optional.

further keyword arguments, e.g. visibility

copy_directory_action

Legacy factory function that creates an action to copy a directory from src to dst.

For improved analysis and runtime performance, it is recommended the switch to copy_directory_bin_action which takes a tool binary, typically the @aspect_bazel_lib//tools/copy_to_directory go_binary either built from source or provided by a toolchain and creates hard links instead of performing full file copies.

This helper is used by copy_directory. It is exposed as a public API so it can be used within other rule implementations.

Example usage (generated):

load("@aspect_bazel_lib//lib:copy_directory.bzl", "copy_directory_action")

copy_directory_action(
# The rule context.
ctx = None,
# The directory to make a copy of
src = "",
# The directory to copy to
dst = None,
)

ctx

Required.

The rule context.

src

Required.

The directory to make a copy of. Can be a source directory or TreeArtifact.

dst

Required.

The directory to copy to. Must be a TreeArtifact.

is_windows

Optional. Default: None

Deprecated and unused

copy_directory_bin_action

Factory function that creates an action to copy a directory from src to dst using a tool binary.

The tool binary will typically be the @aspect_bazel_lib//tools/copy_directory go_binary either built from source or provided by a toolchain.

This helper is used by the copy_directory rule. It is exposed as a public API so it can be used within other rule implementations.

Example usage (generated):

load("@aspect_bazel_lib//lib:copy_directory.bzl", "copy_directory_bin_action")

copy_directory_bin_action(
# The rule context.
ctx = None,
# The source directory to copy.
src = "",
# The directory to copy to
dst = None,
# Copy to directory tool binary.
copy_directory_bin = None,
)

ctx

Required.

The rule context.

src

Required.

The source directory to copy.

dst

Required.

The directory to copy to. Must be a TreeArtifact.

copy_directory_bin

Required.

Copy to directory tool binary.

Optional. Default: "auto"

Controls when to use hardlinks to files instead of making copies.

See copy_directory rule documentation for more details.

verbose

Optional. Default: False

If true, prints out verbose logs to stdout