VersionCatalogBuilder

A version catalog builder. Dependencies defined via this model will trigger the generation of accessors available in build scripts.

Since

7.0

Types

Link copied to clipboard
Allows configuring the version of a library
Link copied to clipboard
Allows configuring the version of a plugin

Functions

Link copied to clipboard
abstract fun bundle(alias: String, aliases: List<String>)
Declares a bundle of dependencies.
Link copied to clipboard
abstract fun from(dependencyNotation: Any)
Configures the model by reading it from a version catalog.
Link copied to clipboard
abstract fun getDescription(): Property<String>
A description for the dependencies model, which will be used in the generated sources as documentation.
Link copied to clipboard
Returns the name of the extension configured by this builder
Link copied to clipboard
abstract fun getName(): String
Link copied to clipboard
abstract fun library(alias: String, groupArtifactVersion: String)
Declare a library alias in full.
abstract fun library(alias: String, group: String, artifact: String): VersionCatalogBuilder.LibraryAliasBuilder
Entry point for registering a library alias.
Link copied to clipboard
Entry point for registering a plugin alias.
Link copied to clipboard
abstract fun version(alias: String, version: String): String
Configures a dependency version which can then be referenced using the versionRef method.
abstract fun version(alias: String, versionSpec: Action<in MutableVersionConstraint>): String
Configures a dependency version which can then be referenced using the versionRef )} method.