bazel-lib/docs/repositories.md

212 lines
8.7 KiB
Markdown
Raw Normal View History

2023-01-16 18:02:17 +00:00
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
Macros for loading dependencies and registering toolchains
<a id="aspect_bazel_lib_dependencies"></a>
## aspect_bazel_lib_dependencies
<pre>
aspect_bazel_lib_dependencies()
2023-01-16 18:02:17 +00:00
</pre>
Load dependencies required by aspect rules
<a id="aspect_bazel_lib_register_toolchains"></a>
## aspect_bazel_lib_register_toolchains
<pre>
aspect_bazel_lib_register_toolchains()
</pre>
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.
<a id="register_bats_toolchains"></a>
## register_bats_toolchains
<pre>
register_bats_toolchains(<a href="#register_bats_toolchains-name">name</a>, <a href="#register_bats_toolchains-core_version">core_version</a>, <a href="#register_bats_toolchains-support_version">support_version</a>, <a href="#register_bats_toolchains-assert_version">assert_version</a>, <a href="#register_bats_toolchains-file_version">file_version</a>,
<a href="#register_bats_toolchains-libraries">libraries</a>, <a href="#register_bats_toolchains-register">register</a>)
</pre>
Registers bats toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_bats_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"bats"` |
| <a id="register_bats_toolchains-core_version"></a>core_version | bats-core version to use | `"v1.10.0"` |
| <a id="register_bats_toolchains-support_version"></a>support_version | bats-support version to use | `"v0.3.0"` |
| <a id="register_bats_toolchains-assert_version"></a>assert_version | bats-assert version to use | `"v2.1.0"` |
| <a id="register_bats_toolchains-file_version"></a>file_version | bats-file version to use | `"v0.4.0"` |
| <a id="register_bats_toolchains-libraries"></a>libraries | additional labels for libraries | `[]` |
| <a id="register_bats_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
<a id="register_copy_directory_toolchains"></a>
## register_copy_directory_toolchains
<pre>
register_copy_directory_toolchains(<a href="#register_copy_directory_toolchains-name">name</a>, <a href="#register_copy_directory_toolchains-register">register</a>)
</pre>
Registers copy_directory toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_copy_directory_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"copy_directory"` |
| <a id="register_copy_directory_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2023-01-16 18:02:17 +00:00
<a id="register_copy_to_directory_toolchains"></a>
## register_copy_to_directory_toolchains
<pre>
register_copy_to_directory_toolchains(<a href="#register_copy_to_directory_toolchains-name">name</a>, <a href="#register_copy_to_directory_toolchains-register">register</a>)
</pre>
Registers copy_to_directory toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_copy_to_directory_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"copy_to_directory"` |
| <a id="register_copy_to_directory_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2023-01-16 18:02:17 +00:00
<a id="register_coreutils_toolchains"></a>
## register_coreutils_toolchains
<pre>
register_coreutils_toolchains(<a href="#register_coreutils_toolchains-name">name</a>, <a href="#register_coreutils_toolchains-version">version</a>, <a href="#register_coreutils_toolchains-register">register</a>)
</pre>
Registers coreutils toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_coreutils_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"coreutils"` |
| <a id="register_coreutils_toolchains-version"></a>version | the version of coreutils to execute (see https://github.com/uutils/coreutils/releases) | `"0.0.26"` |
| <a id="register_coreutils_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
<a id="register_expand_template_toolchains"></a>
## register_expand_template_toolchains
<pre>
register_expand_template_toolchains(<a href="#register_expand_template_toolchains-name">name</a>, <a href="#register_expand_template_toolchains-register">register</a>)
</pre>
Registers expand_template toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_expand_template_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"expand_template"` |
| <a id="register_expand_template_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2023-01-16 18:02:17 +00:00
<a id="register_jq_toolchains"></a>
## register_jq_toolchains
<pre>
register_jq_toolchains(<a href="#register_jq_toolchains-name">name</a>, <a href="#register_jq_toolchains-version">version</a>, <a href="#register_jq_toolchains-register">register</a>)
</pre>
Registers jq toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_jq_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"jq"` |
| <a id="register_jq_toolchains-version"></a>version | the version of jq to execute (see https://github.com/stedolan/jq/releases) | `"1.7"` |
| <a id="register_jq_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
<a id="register_tar_toolchains"></a>
## register_tar_toolchains
<pre>
register_tar_toolchains(<a href="#register_tar_toolchains-name">name</a>, <a href="#register_tar_toolchains-register">register</a>)
</pre>
Registers bsdtar toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_tar_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"bsd_tar"` |
| <a id="register_tar_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2023-01-16 18:02:17 +00:00
<a id="register_yq_toolchains"></a>
## register_yq_toolchains
<pre>
register_yq_toolchains(<a href="#register_yq_toolchains-name">name</a>, <a href="#register_yq_toolchains-version">version</a>, <a href="#register_yq_toolchains-register">register</a>)
</pre>
Registers yq toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_yq_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"yq"` |
| <a id="register_yq_toolchains-version"></a>version | the version of yq to execute (see https://github.com/mikefarah/yq/releases) | `"4.25.2"` |
| <a id="register_yq_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2023-01-16 18:02:17 +00:00
2024-05-03 23:12:56 +00:00
<a id="register_zstd_toolchains"></a>
## register_zstd_toolchains
<pre>
register_zstd_toolchains(<a href="#register_zstd_toolchains-name">name</a>, <a href="#register_zstd_toolchains-register">register</a>)
</pre>
Registers zstd toolchain and repositories
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="register_zstd_toolchains-name"></a>name | override the prefix for the generated toolchain repositories | `"zstd"` |
| <a id="register_zstd_toolchains-register"></a>register | whether to call through to native.register_toolchains. Should be True for WORKSPACE users, but false when used under bzlmod extension | `True` |
2024-05-03 23:12:56 +00:00