Setting the file. One moment.
Subchapter 27.2
references/languages/java/bom-migration/bom-gradle-settings.mdMarkdown7 KBView on GitHub
settings.gradle)Some projects define version catalogs programmatically in settings.gradle / settings.gradle.kts instead of using a TOML file. OpenRewrite does not support this either (). Handle manually.
Use TARGET_AZURE_SDK_BOM_VERSION resolved in the workflow. Do not keep an existing programmatic catalog BOM version unless it exactly matches that value.
Look for a dependencyResolutionManagement block in settings.gradle or settings.gradle.kts:
// settings.gradle (Groovy DSL)
dependencyResolutionManagement {
versionCatalogs {
libs {
version("azureSdk", "1.41.4")
version("azureStorage", "8.6.6")
library("azure", "com.microsoft.azure", "azure").versionRef("azureSdk")
library("azure-storage", "com.microsoft.azure", "azure-storage").versionRef("azureStorage")
}
}
}// settings.gradle.kts (Kotlin DSL)
dependencyResolutionManagement {
versionCatalogs {
create("libs") {
version("azureSdk", "1.41.4")
version("azureStorage", "8.6.6")
library("azure", "com.microsoft.azure", "azure").versionRef("azureSdk")
library("azure-storage", "com.microsoft.azure", "azure-storage").versionRef("azureStorage")
}
}
}The library() call can also use the two-arg module form (the same syntax applies to Kotlin DSL):
library("azure", "com.microsoft.azure:azure").versionRef("azureSdk")
library("azure-inline", "com.microsoft.azure:azure").version("1.41.4")If the project has this pattern and contains Azure dependency entries, use this section. The same libs.<alias> accessor syntax is used in build.gradle as with TOML catalogs.
Add a version and library entry for the BOM inside the versionCatalogs block:
// Groovy DSL
dependencyResolutionManagement {
versionCatalogs {
libs {
version("azureSdkBom", "{bom_version}")
library("azure-sdk-bom", "com.azure", "azure-sdk-bom").versionRef("azureSdkBom")
}
}
}// Kotlin DSL
dependencyResolutionManagement {
versionCatalogs {
create("libs") {
version("azureSdkBom", "{bom_version}")
library("azure-sdk-bom", "com.azure", "azure-sdk-bom").versionRef("azureSdkBom")
}
}
}If a BOM entry already exists, update the version string.
Add the platform dependency (if not already present).
Groovy DSL (build.gradle):
dependencies {
implementation enforcedPlatform(libs.azure.sdk.bom)
}Kotlin DSL (build.gradle.kts):
dependencies {
implementation(enforcedPlatform(libs.azure.sdk.bom))
}For each modern Azure library (com.azure.*) managed by the BOM, change its catalog entry to remove the version. Use the withoutVersion() call:
The snippets below show Groovy DSL (settings.gradle); the same code applies to Kotlin DSL (settings.gradle.kts).
Before:
library("azure-identity", "com.azure", "azure-identity").versionRef("azureIdentity")After:
library("azure-identity", "com.azure", "azure-identity").withoutVersion()For the two-arg module form (the same syntax applies to Kotlin DSL):
// Before
library("azure-identity", "com.azure:azure-identity").versionRef("azureIdentity")
// After
library("azure-identity", "com.azure:azure-identity").withoutVersion()Then remove any orphaned version(...) calls that are no longer referenced.
For each legacy com.microsoft.azure.* library call:
com.azure.* equivalent..versionRef(...) or .version(...) to .withoutVersion() if the new artifact is managed by the BOM.version(...) calls.build.gradle / build.gradle.kts and any bundle(...) calls.The snippets below show Groovy DSL (settings.gradle); the same code applies to Kotlin DSL (settings.gradle.kts).
Before:
version("azureSdk", "1.41.4")
version("azureStorage", "8.6.6")
library("azure", "com.microsoft.azure", "azure").versionRef("azureSdk")
library("azure-storage", "com.microsoft.azure", "azure-storage").versionRef("azureStorage")After:
library("azure-resourcemanager", "com.azure.resourcemanager", "azure-resourcemanager").withoutVersion()
library("azure-storage-blob", "com.azure", "azure-storage-blob").withoutVersion()Then update build.gradle (Groovy DSL):
// Before
implementation libs.azure
implementation libs.azure.storage
// After
implementation libs.azure.resourcemanager
implementation libs.azure.storage.blobOr build.gradle.kts (Kotlin DSL):
// Before
implementation(libs.azure)
implementation(libs.azure.storage)
// After
implementation(libs.azure.resourcemanager)
implementation(libs.azure.storage.blob)If bundle(...) calls reference any renamed or removed aliases, update them:
Groovy DSL (settings.gradle):
// Before
bundle("azureLibs", ["azure", "azure-storage"])
// After
bundle("azureLibs", ["azure-resourcemanager", "azure-storage-blob", "azure-identity"])Kotlin DSL (settings.gradle.kts):
// Before
bundle("azureLibs", listOf("azure", "azure-storage"))
// After
bundle("azureLibs", listOf("azure-resourcemanager", "azure-storage-blob", "azure-identity"))Groovy DSL (settings.gradle):
dependencyResolutionManagement {
versionCatalogs {
libs {
version("azureSdkBom", "{bom_version}")
library("azure-sdk-bom", "com.azure", "azure-sdk-bom").versionRef("azureSdkBom")
library("azure-identity", "com.azure", "azure-identity").withoutVersion()
library("azure-resourcemanager", "com.azure.resourcemanager", "azure-resourcemanager").withoutVersion()
}
}
}Kotlin DSL (settings.gradle.kts):
dependencyResolutionManagement {
versionCatalogs {
create("libs") {
version("azureSdkBom", "{bom_version}")
library("azure-sdk-bom", "com.azure", "azure-sdk-bom").versionRef("azureSdkBom")
library("azure-identity", "com.azure", "azure-identity").withoutVersion()
library("azure-resourcemanager", "com.azure.resourcemanager", "azure-resourcemanager").withoutVersion()
}
}
}