These are the basic functions to get started.
To use these functions, load them at the top of your BUILD file. For example:
load("@rules_jvm_external//:defs.bzl", "maven_install", "artifact")maven_install(name, repositories, artifacts, fail_on_missing_checksum, fetch_sources, use_unsafe_shared_cache, excluded_artifacts, generate_compat_repositories, version_conflict_policy, maven_install_json, override_targets, strict_visibility, resolve_timeout, jetify)
Resolves and fetches artifacts transitively from Maven repositories.
This macro runs a repository rule that invokes the Coursier CLI to resolve and fetch Maven artifacts transitively.
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| name | A unique name for this Bazel external repository. | "maven" |
| repositories | A list of Maven repository URLs, specified in lookup order. Supports URLs with HTTP Basic Authentication, e.g. "https://username:[email protected]". |
[] |
| artifacts | A list of Maven artifact coordinates in the form of group:artifact:version. |
[] |
| fail_on_missing_checksum | - |
True |
| fetch_sources | Additionally fetch source JARs. | False |
| use_unsafe_shared_cache | Download artifacts into a persistent shared cache on disk. Unsafe as Bazel is currently unable to detect modifications to the cache. | False |
| excluded_artifacts | A list of Maven artifact coordinates in the form of group:artifact to be excluded from the transitive dependencies. |
[] |
| generate_compat_repositories | Additionally generate repository aliases in a .bzl file for all JAR artifacts. For example, @maven//:com_google_guava_guava can also be referenced as @com_google_guava_guava//jar. |
False |
| version_conflict_policy | Policy for user-defined vs. transitive dependency version conflicts. If "pinned", choose the user's version unconditionally. If "default", follow Coursier's default policy. | "default" |
| maven_install_json | A label to a maven_install.json file to use pinned artifacts for generating build targets. e.g //:maven_install.json. |
None |
| override_targets | A mapping of group:artifact to Bazel target labels. All occurrences of the target label for group:artifact will be an alias to the specified label, therefore overriding the original generated jvm_import or aar_import target. |
{} |
| strict_visibility | Controls visibility of transitive dependencies. If True, transitive dependencies are private and invisible to user's rules. If False, transitive dependencies are public and visible to user's rules. |
False |
| resolve_timeout | The execution timeout of resolving and fetching artifacts. | 600 |
| jetify | Runs the AndroidX jetifier tool on all artifacts. | False |
These are helper functions to specify more information about Maven artifacts and
repositories in maven_install.
To use these functions, load the maven struct at the top of your BUILD file:
load("@rules_jvm_external//:specs.bzl", "maven")maven.repository(url, user, password)
Generates the data map for a Maven repository specifier given the available information.
If both a user and password are given as arguments, it will include the access credentials in the repository spec. If one or both are missing, it will just generate the repository url.
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| url | A string containing the repository url (ex: "https://maven.google.com/"). | none |
| user | A username for this Maven repository, if it requires authentication (ex: "johndoe"). | None |
| password | A password for this Maven repository, if it requires authentication (ex: "example-password"). | None |
maven.artifact(group, artifact, version, packaging, classifier, override_license_types, exclusions, neverlink, testonly)
Generates the data map for a Maven artifact given the available information about its coordinates.
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| group | The Maven artifact coordinate group name (ex: "com.google.guava"). | none |
| artifact | The Maven artifact coordinate artifact name (ex: "guava"). | none |
| version | The Maven artifact coordinate version name (ex: "27.0-jre"). | none |
| packaging | The Maven packaging specifier (ex: "jar"). | None |
| classifier | The Maven artifact classifier (ex: "javadoc"). | None |
| override_license_types | An array of Bazel license type strings to use for this artifact's rules (overrides autodetection) (ex: ["notify"]). | None |
| exclusions | An array of exclusion objects to create exclusion specifiers for this artifact (ex: maven.exclusion("junit", "junit")). | None |
| neverlink | Determines if this artifact should be part of the runtime classpath. | None |
| testonly | Determines whether this artifact is available for targets not marked as testonly = True. |
None |
maven.exclusion(group, artifact)
Generates the data map for a Maven artifact exclusion.
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| group | The Maven group name of the dependency to exclude, e.g. "com.google.guava". | none |
| artifact | The Maven artifact name of the dependency to exclude, e.g. "guava". | none |