bazel-lib/docs/repositories.md

9.0 KiB

Macros for loading dependencies and registering toolchains

aspect_bazel_lib_dependencies

aspect_bazel_lib_dependencies()

Load dependencies required by aspect rules

aspect_bazel_lib_register_toolchains

aspect_bazel_lib_register_toolchains()

Register all bazel-lib toolchains at their default versions.

To be more selective about which toolchains and versions to register, call the individual toolchain registration macros.

register_bats_toolchains

register_bats_toolchains(name, core_version, support_version, assert_version, file_version,
                         libraries, register)

Registers bats toolchain and repositories

PARAMETERS

Name Description Default Value
name override the prefix for the generated toolchain repositories "bats"
core_version bats-core version to use "v1.10.0"
support_version bats-support version to use "v0.3.0"
assert_version bats-assert version to use "v2.1.0"
file_version bats-file version to use "v0.4.0"
libraries additional labels for libraries []
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_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.26"
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.7"
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

register_zstd_toolchains

register_zstd_toolchains(name, register)

Registers zstd toolchain and repositories

PARAMETERS

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