bazel-lib/docs/repositories.md

6.8 KiB

Macros for loading dependencies and registering toolchains

aspect_bazel_lib_dependencies

aspect_bazel_lib_dependencies(override_local_config_platform)

Load dependencies required by aspect rules

PARAMETERS

Name Description Default Value
override_local_config_platform override the @local_config_platform repository with one that adds stardoc support for loading constraints.bzl.

Should be set in repositories that load @aspect_bazel_lib copy actions and also generate stardoc.
False

register_copy_directory_toolchains

register_copy_directory_toolchains(name, register)

Registers copy_directory toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "copy_directory"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_copy_to_directory_toolchains

register_copy_to_directory_toolchains(name, register)

Registers copy_to_directory toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "copy_to_directory"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_coreutils_toolchains

register_coreutils_toolchains(name, version, register)

Registers coreutils toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "coreutils"
version the version of coreutils to execute (see https://github.com/uutils/coreutils/releases) "0.0.16"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_expand_template_toolchains

register_expand_template_toolchains(name, register)

Registers expand_template toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "expand_template"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_jq_toolchains

register_jq_toolchains(name, version, register)

Registers jq toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "jq"
version the version of jq to execute (see https://github.com/stedolan/jq/releases) "1.6"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_tar_toolchains

register_tar_toolchains(name, register)

Registers bsdtar toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "bsd_tar"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True

register_yq_toolchains

register_yq_toolchains(name, version, register)

Registers yq toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "yq"
version the version of yq to execute (see https://github.com/mikefarah/yq/releases) "4.25.2"
register whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension True