Update to Micronaut 4.x platform BOM
org.openrewrite.java.micronaut.UpdateMicronautPlatformBom
This recipe will update a Gradle or Maven build to reference the Micronaut 4 platform BOM.
Recipe source
GitHub, Issue Tracker, Maven Central
This recipe is available under the Apache License Version 2.0.
Definition
- Recipe List
- Yaml Recipe List
- Change Maven parent
- oldGroupId:
io.micronaut - newGroupId:
io.micronaut.platform - oldArtifactId:
micronaut-parent - newVersion:
4.x
- oldGroupId:
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.micronaut.UpdateMicronautPlatformBom
displayName: Update to Micronaut 4.x platform BOM
description: |
This recipe will update a Gradle or Maven build to reference the Micronaut 4 platform BOM.
recipeList:
- org.openrewrite.maven.ChangeParentPom:
oldGroupId: io.micronaut
newGroupId: io.micronaut.platform
oldArtifactId: micronaut-parent
newVersion: 4.x
Used by
This recipe is used as part of the following composite recipes:
Examples
Example 1
UpdateBuildPluginsTest#updateGradleBuildPlugins
Unchanged
plugins {
id("com.github.johnrengelman.shadow") version "7.1.2"
id("io.micronaut.application") version "3.7.9"
id("io.micronaut.minimal.application") version "3.7.9"
id("io.micronaut.aot") version "3.7.9"
id("io.micronaut.component") version "3.7.9"
id("io.micronaut.crac") version "3.7.9"
id("io.micronaut.docker") version "3.7.9"
id("io.micronaut.graalvm") version "3.7.9"
id("io.micronaut.library") version "3.7.9"
id("io.micronaut.minimal.library") version "3.7.9"
id("io.micronaut.test-resources") version "3.5.1"
}
repositories {
mavenCentral()
}
Unchanged
micronautVersion=3.9.1
Example 2
UpdateMicronautDataTest#updateSQLAnnotations
- java
- Diff
Before
import io.micronaut.data.jdbc.annotation.ColumnTransformer;
import io.micronaut.data.jdbc.annotation.JoinColumn;
import io.micronaut.data.jdbc.annotation.JoinColumns;
import io.micronaut.data.jdbc.annotation.JoinTable;
public class MyEntity {
@JoinTable(
name = "m2m_address_association",
joinColumns = @JoinColumns({
@JoinColumn(name="ADDR_ID", referencedColumnName="ID"),
@JoinColumn(name="ADDR_ZIP", referencedColumnName="ZIP")
}))
List<String> addresses;
@ColumnTransformer(read = "UPPER(org)")
private String name;
}
After
import io.micronaut.data.annotation.sql.ColumnTransformer;
import io.micronaut.data.annotation.sql.JoinColumn;
import io.micronaut.data.annotation.sql.JoinColumns;
import io.micronaut.data.annotation.sql.JoinTable;
public class MyEntity {
@JoinTable(
name = "m2m_address_association",
joinColumns = @JoinColumns({
@JoinColumn(name="ADDR_ID", referencedColumnName="ID"),
@JoinColumn(name="ADDR_ZIP", referencedColumnName="ZIP")
}))
List<String> addresses;
@ColumnTransformer(read = "UPPER(org)")
private String name;
}
@@ -1,4 +1,4 @@
-import io.micronaut.data.jdbc.annotation.ColumnTransformer;
-import io.micronaut.data.jdbc.annotation.JoinColumn;
-import io.micronaut.data.jdbc.annotation.JoinColumns;
-import io.micronaut.data.jdbc.annotation.JoinTable;
+import io.micronaut.data.annotation.sql.ColumnTransformer;
+import io.micronaut.data.annotation.sql.JoinColumn;
+import io.micronaut.data.annotation.sql.JoinColumns;
+import io.micronaut.data.annotation.sql.JoinTable;
Unchanged
project
Example 3
UpdateMicronautSessionTest#updateGradleDependencies
- build.gradle
- Diff
Before
plugins {
id "java-library"
}
dependencies {
implementation("io.micronaut:micronaut-session")
}
repositories {
mavenCentral()
}
After
plugins {
id "java-library"
}
dependencies {
implementation("io.micronaut.session:micronaut-session")
}
repositories {
mavenCentral()
}
--- build.gradle
+++ build.gradle
@@ -5,1 +5,1 @@
}
dependencies {
- implementation("io.micronaut:micronaut-session")
+ implementation("io.micronaut.session:micronaut-session")
}
Unchanged
project
Example 4
UpdateBuildPluginsTest#updateGradleBuildPlugins
Unchanged
plugins {
id("com.github.johnrengelman.shadow") version "7.1.2"
id("io.micronaut.application") version "3.7.9"
id("io.micronaut.minimal.application") version "3.7.9"
id("io.micronaut.aot") version "3.7.9"
id("io.micronaut.component") version "3.7.9"
id("io.micronaut.crac") version "3.7.9"
id("io.micronaut.docker") version "3.7.9"
id("io.micronaut.graalvm") version "3.7.9"
id("io.micronaut.library") version "3.7.9"
id("io.micronaut.minimal.library") version "3.7.9"
id("io.micronaut.test-resources") version "3.5.1"
}
repositories {
mavenCentral()
}
Unchanged
micronautVersion=3.9.1
Example 5
UpdateMicronautDataTest#updateSQLAnnotations
- java
- Diff
Before
import io.micronaut.data.jdbc.annotation.ColumnTransformer;
import io.micronaut.data.jdbc.annotation.JoinColumn;
import io.micronaut.data.jdbc.annotation.JoinColumns;
import io.micronaut.data.jdbc.annotation.JoinTable;
public class MyEntity {
@JoinTable(
name = "m2m_address_association",
joinColumns = @JoinColumns({
@JoinColumn(name="ADDR_ID", referencedColumnName="ID"),
@JoinColumn(name="ADDR_ZIP", referencedColumnName="ZIP")
}))
List<String> addresses;
@ColumnTransformer(read = "UPPER(org)")
private String name;
}
After
import io.micronaut.data.annotation.sql.ColumnTransformer;
import io.micronaut.data.annotation.sql.JoinColumn;
import io.micronaut.data.annotation.sql.JoinColumns;
import io.micronaut.data.annotation.sql.JoinTable;
public class MyEntity {
@JoinTable(
name = "m2m_address_association",
joinColumns = @JoinColumns({
@JoinColumn(name="ADDR_ID", referencedColumnName="ID"),
@JoinColumn(name="ADDR_ZIP", referencedColumnName="ZIP")
}))
List<String> addresses;
@ColumnTransformer(read = "UPPER(org)")
private String name;
}
@@ -1,4 +1,4 @@
-import io.micronaut.data.jdbc.annotation.ColumnTransformer;
-import io.micronaut.data.jdbc.annotation.JoinColumn;
-import io.micronaut.data.jdbc.annotation.JoinColumns;
-import io.micronaut.data.jdbc.annotation.JoinTable;
+import io.micronaut.data.annotation.sql.ColumnTransformer;
+import io.micronaut.data.annotation.sql.JoinColumn;
+import io.micronaut.data.annotation.sql.JoinColumns;
+import io.micronaut.data.annotation.sql.JoinTable;
Unchanged
project
Example 6
UpdateMicronautSessionTest#updateGradleDependencies
- build.gradle
- Diff
Before
plugins {
id "java-library"
}
dependencies {
implementation("io.micronaut:micronaut-session")
}
repositories {
mavenCentral()
}
After
plugins {
id "java-library"
}
dependencies {
implementation("io.micronaut.session:micronaut-session")
}
repositories {
mavenCentral()
}
--- build.gradle
+++ build.gradle
@@ -5,1 +5,1 @@
}
dependencies {
- implementation("io.micronaut:micronaut-session")
+ implementation("io.micronaut.session:micronaut-session")
}
Unchanged
project
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-micronaut in your build file or by running a shell command (in which case no build changes are needed):
- Gradle
- Gradle init script
- Maven POM
- Maven Command Line
- Moderne CLI
- Add the following to your
build.gradlefile:
plugins {
id("org.openrewrite.rewrite") version("latest.release")
}
rewrite {
activeRecipe("org.openrewrite.java.micronaut.UpdateMicronautPlatformBom")
setExportDatatables(true)
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-micronaut:2.29.1")
}
- Run
gradle rewriteRunto run the recipe.
- Create a file named
init.gradlein the root of your project.
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:7.19.0") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-micronaut:2.29.1")
}
rewrite {
activeRecipe("org.openrewrite.java.micronaut.UpdateMicronautPlatformBom")
setExportDatatables(true)
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- Run the recipe.
gradle --init-script init.gradle rewriteRun
- Add the following to your
pom.xmlfile:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>6.22.1</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>org.openrewrite.java.micronaut.UpdateMicronautPlatformBom</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-micronaut</artifactId>
<version>2.29.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:runto run the recipe.
You will need to have Maven installed on your machine before you can run the following command.
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-micronaut:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.micronaut.UpdateMicronautPlatformBom -Drewrite.exportDatatables=true
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe UpdateMicronautPlatformBom
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-micronaut:2.29.1
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Data Tables
- MavenMetadataFailures
- SourcesFileResults
- SourcesFileErrors
- RecipeRunStats
Maven metadata failures
org.openrewrite.maven.table.MavenMetadataFailures
Attempts to resolve maven metadata that failed.
| Column Name | Description |
|---|---|
| Group id | The groupId of the artifact for which the metadata download failed. |
| Artifact id | The artifactId of the artifact for which the metadata download failed. |
| Version | The version of the artifact for which the metadata download failed. |
| Maven repository | The URL of the Maven repository that the metadata download failed on. |
| Snapshots | Does the repository support snapshots. |
| Releases | Does the repository support releases. |
| Failure | The reason the metadata download failed. |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
| Column Name | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
| Column Name | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
| Column Name | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |