Skip to content

Commit a88c56e

Browse files
authored
Refresh the docs (#1406)
1 parent 09d3864 commit a88c56e

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/bzlmod-api.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88

99
<pre>
1010
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
11+
maven.amend_artifact(<a href="#maven.amend_artifact-name">name</a>, <a href="#maven.amend_artifact-coordinates">coordinates</a>, <a href="#maven.amend_artifact-exclusions">exclusions</a>, <a href="#maven.amend_artifact-force_version">force_version</a>, <a href="#maven.amend_artifact-neverlink">neverlink</a>, <a href="#maven.amend_artifact-testonly">testonly</a>)
1112
maven.artifact(<a href="#maven.artifact-name">name</a>, <a href="#maven.artifact-artifact">artifact</a>, <a href="#maven.artifact-classifier">classifier</a>, <a href="#maven.artifact-exclusions">exclusions</a>, <a href="#maven.artifact-force_version">force_version</a>, <a href="#maven.artifact-group">group</a>, <a href="#maven.artifact-neverlink">neverlink</a>, <a href="#maven.artifact-packaging">packaging</a>,
1213
<a href="#maven.artifact-testonly">testonly</a>, <a href="#maven.artifact-version">version</a>)
14+
maven.from_toml(<a href="#maven.from_toml-name">name</a>, <a href="#maven.from_toml-bom_modules">bom_modules</a>, <a href="#maven.from_toml-libs_versions_toml">libs_versions_toml</a>)
1315
maven.install(<a href="#maven.install-name">name</a>, <a href="#maven.install-aar_import_bzl_label">aar_import_bzl_label</a>, <a href="#maven.install-additional_coursier_options">additional_coursier_options</a>, <a href="#maven.install-additional_netrc_lines">additional_netrc_lines</a>,
1416
<a href="#maven.install-artifacts">artifacts</a>, <a href="#maven.install-boms">boms</a>, <a href="#maven.install-duplicate_version_warning">duplicate_version_warning</a>, <a href="#maven.install-excluded_artifacts">excluded_artifacts</a>, <a href="#maven.install-exclusions">exclusions</a>,
1517
<a href="#maven.install-fail_if_repin_required">fail_if_repin_required</a>, <a href="#maven.install-fail_on_missing_checksum">fail_on_missing_checksum</a>, <a href="#maven.install-fetch_javadoc">fetch_javadoc</a>, <a href="#maven.install-fetch_sources">fetch_sources</a>,
@@ -23,6 +25,23 @@ maven.override(<a href="#maven.override-name">name</a>, <a href="#maven.override
2325

2426
**TAG CLASSES**
2527

28+
<a id="maven.amend_artifact"></a>
29+
30+
### amend_artifact
31+
32+
Modifies an artifact with `coordinates` defined in other tags with additional properties.
33+
34+
**Attributes**
35+
36+
| Name | Description | Type | Mandatory | Default |
37+
| :------------- | :------------- | :------------- | :------------- | :------------- |
38+
| <a id="maven.amend_artifact-name"></a>name | - | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | optional | `"maven"` |
39+
| <a id="maven.amend_artifact-coordinates"></a>coordinates | Coordinates of the artifact to amend. Only `group:artifact` are used for matching. | String | required | |
40+
| <a id="maven.amend_artifact-exclusions"></a>exclusions | Maven artifact tuples, in `artifactId:groupId` format | List of strings | optional | `[]` |
41+
| <a id="maven.amend_artifact-force_version"></a>force_version | - | Boolean | optional | `False` |
42+
| <a id="maven.amend_artifact-neverlink"></a>neverlink | - | Boolean | optional | `False` |
43+
| <a id="maven.amend_artifact-testonly"></a>testonly | - | Boolean | optional | `False` |
44+
2645
<a id="maven.artifact"></a>
2746

2847
### artifact
@@ -44,6 +63,20 @@ Used to define a single artifact where the simple coordinates are insufficient.
4463
| <a id="maven.artifact-testonly"></a>testonly | - | Boolean | optional | `False` |
4564
| <a id="maven.artifact-version"></a>version | - | String | optional | `""` |
4665

66+
<a id="maven.from_toml"></a>
67+
68+
### from_toml
69+
70+
Allows a project to import dependencies from a Gradle format `libs.versions.toml` file.
71+
72+
**Attributes**
73+
74+
| Name | Description | Type | Mandatory | Default |
75+
| :------------- | :------------- | :------------- | :------------- | :------------- |
76+
| <a id="maven.from_toml-name"></a>name | - | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | optional | `"maven"` |
77+
| <a id="maven.from_toml-bom_modules"></a>bom_modules | List of modules in `group:artifact` format to treat as BOMs, not artifacts | List of strings | optional | `[]` |
78+
| <a id="maven.from_toml-libs_versions_toml"></a>libs_versions_toml | Gradle `libs.versions.toml` file to use | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
79+
4780
<a id="maven.install"></a>
4881

4982
### install

0 commit comments

Comments
 (0)