Release on 2024-06-19 & generate latest versions page (#120)

* Release on 2024-06-19 * Also generate latest-versions-of-every-openrewrite-module.md * Rename file to match release date
openrewrite · Jun 20, 2024 · 656bd10 · 656bd10
1 parent 208a9d1
commit 656bd10
Show file tree

Hide file tree

Showing 5 changed files with 507 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -84,6 +84,13 @@ Quickstart:
 ./gradlew markdownToHtml
 ```
 
+### Replace rewrite-docs references
+```shell
+rm -rf ../../rewrite-docs/reference/recipes
+cp -r build/docs/reference/recipes ../../rewrite-docs/reference/
+cp -r build/docs/latest-versions-of-every-openrewrite-module.md ../../rewrite-docs/reference/
+```
+
 ## Known Issues
 
 The `SUMMARY_snippet.md` file generated does not entirely match the one in the `rewrite-docs` repository. This is 

diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -8,7 +8,6 @@ import com.fasterxml.jackson.module.kotlin.registerKotlinModule
 import com.github.difflib.DiffUtils
 import com.github.difflib.patch.Patch
 import org.openrewrite.config.CategoryDescriptor
-import org.openrewrite.config.DataTableDescriptor
 import org.openrewrite.config.Environment
 import org.openrewrite.config.RecipeDescriptor
 import org.openrewrite.internal.StringUtils
@@ -98,6 +97,33 @@ class RecipeMarkdownGenerator : Runnable {
         if (recipeSources.isNotEmpty() && recipeClasspath.isNotEmpty()) {
             recipeOrigins = RecipeOrigin.parse(recipeSources)
 
+            // Write VERSIONS_snippet.md
+            val versionsSnippetPath = outputPath.resolve("latest-versions-of-every-openrewrite-module.md")
+            Files.newBufferedWriter(versionsSnippetPath, StandardOpenOption.CREATE).useAndApply {
+                writeln("""
+                    # Latest versions of every OpenRewrite module
+                    
+                    OpenRewrite's modules are published to [Maven Central](https://search.maven.org/search?q=org.openrewrite).
+                    Each time a release is made, a bill of materials artifact is also published to correctly align and manage the versions of all published artifacts.
+                    The Gradle plugin is published to the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.openrewrite.rewrite).
+                    
+                    It is highly recommended that developers use the [rewrite-recipe-bom](https://github.com/openrewrite/rewrite-recipe-bom)
+                    to align the versions of Rewrite's modules to ensure compatibility.
+                    The use of the "bill of materials" means that a developer will only need to specify explicit versions of the BOM and the build plugins:
+                    
+                    | Module                                                                                                                | Version    |
+                    |-----------------------------------------------------------------------------------------------------------------------| ---------- |
+                    | [**org.openrewrite.recipe:rewrite-recipe-bom**](https://github.com/openrewrite/rewrite-recipe-bom)                    |            |
+                    | [**org.openrewrite:rewrite-maven-plugin**](https://github.com/openrewrite/rewrite-maven-plugin)                       | **${mavenPluginVersion}** |
+                    | [**org.openrewrite:rewrite-gradle-plugin**](https://github.com/openrewrite/rewrite-gradle-plugin)                     | **${gradlePluginVersion}** |
+                    """.trimIndent())
+                for (recipeOrigin in recipeOrigins.values) {
+                    val repoLink = "[${recipeOrigin.groupId}:${recipeOrigin.artifactId}](${recipeOrigin.githubUrl()})"
+                    val releaseLink = "[${recipeOrigin.version}](${recipeOrigin.githubUrl()}/releases/tag/v${recipeOrigin.version})"
+                    writeln("| ${repoLink.padEnd(117)} | ${releaseLink} |")
+                }
+            }
+
             val classloader = recipeClasspath.split(";")
                 .map(Paths::get)
                 .map(Path::toUri)

diff --git a/src/main/kotlin/org/openrewrite/RecipeOrigin.kt b/src/main/kotlin/org/openrewrite/RecipeOrigin.kt
@@ -20,6 +20,14 @@ class RecipeOrigin(
     private fun convertNameToJavaPath(recipeName: String): String =
         recipeName.replace('.', '/').replace(Regex("Recipes?\\$?.*"), "") + ".java"
 
+    fun githubUrl(): String {
+        return if (isFromCoreLibrary()) {
+            "https://github.com/openrewrite/rewrite"
+        } else {
+            "https://github.com/openrewrite/$artifactId"
+        }
+    }
+
     fun githubUrl(recipeName: String, source: URI): String {
         if (artifactId == "rewrite-third-party") {
             return "https://github.com/search?type=code&q=$recipeName"

diff --git a/src/main/resources/CHANGELOG-2024-06-19.md b/src/main/resources/CHANGELOG-2024-06-19.md
@@ -0,0 +1,91 @@
+# 8.28.1 release (2024-06-19)
+
+{% hint style="info" %}
+This changelog only shows what recipes have been added, removed, or changed. OpenRewrite may do releases that do not include these types of changes. To see these changes, please go to the [releases page](https://github.com/openrewrite/rewrite/releases).
+{% endhint %}
+
+## New Recipes
+
+* [io.quarkus.updates.camel.camel40.UsePluginHelperForContextGetters](https://docs.openrewrite.org/recipes/io/quarkus/updates/camel/camel40/usepluginhelperforcontextgetters):  
+* [io.quarkus.updates.camel.customRecipes.MoveGetterToPluginHelper](https://docs.openrewrite.org/recipes/io/quarkus/updates/camel/customrecipes/movegettertopluginhelper): Move getter from context to PluginHelper 
+* [io.quarkus.updates.core.quarkus39.GraalSDK](https://docs.openrewrite.org/recipes/io/quarkus/updates/core/quarkus39/graalsdk):  
+* [io.quarkus.updates.core.quarkus39.SyncHibernateJpaModelgenVersionWithBOM](https://docs.openrewrite.org/recipes/io/quarkus/updates/core/quarkus39/synchibernatejpamodelgenversionwithbom):  
+* [org.openrewrite.MyRecipe](https://docs.openrewrite.org/recipes/myrecipe):  
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipes): Replace calls to `Logger.log(Level, String)` with the corresponding method calls. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelConfigSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelconfigsuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.CONFIG, Supplier<String>)` with `Logger.config(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelConfigToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelconfigtomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.CONFIG, String)` with `Logger.config(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFineSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinesuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINE, Supplier<String>)` with `Logger.fine(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFineToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinetomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINE, String)` with `Logger.fine(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFinerSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinersuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINER, Supplier<String>)` with `Logger.finer(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFinerToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINER, String)` with `Logger.finer(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFinestSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinestsuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINEST, Supplier<String>)` with `Logger.finest(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelFinestToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelfinesttomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.FINEST, String)` with `Logger.finest(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelInfoSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelinfosuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.INFO, Supplier<String>)` with `Logger.info(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelInfoToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelinfotomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.INFO, String)` with `Logger.info(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelSevereSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelseveresuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.SEVERE, Supplier<String>)` with `Logger.severe(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelSevereToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelseveretomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.SEVERE, String)` with `Logger.severe(String)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelWarningSupplierToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelwarningsuppliertomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.WARNING, Supplier<String>)` with `Logger.warning(Supplier<String>)`. 
+* [org.openrewrite.java.logging.jul.LoggerLevelArgumentToMethodRecipes$LogLevelWarningToMethodRecipe](https://docs.openrewrite.org/recipes/java/logging/jul/loggerlevelargumenttomethodrecipesusdloglevelwarningtomethodrecipe): Replace calls to `java.util.logging.Logger.log(Level.WARNING, String)` with `Logger.warning(String)`. 
+* [org.openrewrite.java.logging.slf4j.JulGetLoggerToLoggerFactoryRecipes](https://docs.openrewrite.org/recipes/java/logging/slf4j/julgetloggertologgerfactoryrecipes): Replace calls to `Logger.getLogger` with `LoggerFactory.getLogger`. 
+* [org.openrewrite.java.logging.slf4j.JulGetLoggerToLoggerFactoryRecipes$GetLoggerClassCanonicalNameToLoggerFactoryRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julgetloggertologgerfactoryrecipesusdgetloggerclasscanonicalnametologgerfactoryrecipe): Replace calls to `java.util.logging.Logger.getLogger(Some.class.getCanonicalName())` with `org.slf4j.LoggerFactory.getLogger(Some.class)`. 
+* [org.openrewrite.java.logging.slf4j.JulGetLoggerToLoggerFactoryRecipes$GetLoggerClassNameToLoggerFactoryRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julgetloggertologgerfactoryrecipesusdgetloggerclassnametologgerfactoryrecipe): Replace calls to `java.util.logging.Logger.getLogger(Some.class.getName())` with `org.slf4j.LoggerFactory.getLogger(Some.class)`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipes): Replace calls to `Logger.isLoggable(Level)` with the corresponding SLF4J method calls. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelAllRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelallrecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.ALL)` with `org.slf4j.Logger.isTraceEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelConfigRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelconfigrecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.CONFIG)` with `org.slf4j.Logger.isInfoEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelFineRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelfinerecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.FINE)` with `org.slf4j.Logger.isDebugEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelFinerRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelfinerrecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.FINER)` with `org.slf4j.Logger.isTraceEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelFinestRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelfinestrecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.FINEST)` with `org.slf4j.Logger.isTraceEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelInfoRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelinforecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.INFO)` with `org.slf4j.Logger.isInfoEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelSevereRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelsevererecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.SEVERE)` with `org.slf4j.Logger.isErrorEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulIsLoggableToIsEnabledRecipes$LoggerIsLoggableLevelWarningRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/julisloggabletoisenabledrecipesusdloggerisloggablelevelwarningrecipe): Replace calls to `java.util.logging.Logger.isLoggable(Level.WARNING)` with `org.slf4j.Logger.isWarnEnabled()`. 
+* [org.openrewrite.java.logging.slf4j.JulLevelAllToTraceRecipe](https://docs.openrewrite.org/recipes/java/logging/slf4j/jullevelalltotracerecipe): Replace `java.util.logging.Logger#log(Level.ALL, String)` with `org.slf4j.Logger#trace(String)`. 
+* [org.openrewrite.java.logging.slf4j.JulToSlf4j](https://docs.openrewrite.org/recipes/java/logging/slf4j/jultoslf4j): Migrates usage of Java Util Logging (JUL) to using SLF4J directly. 
+* [org.openrewrite.java.migrate.IBMJDKtoOracleJDK](https://docs.openrewrite.org/recipes/java/migrate/ibmjdktooraclejdk): This recipe will apply changes commonly needed when upgrading Java versions. The solutions provided in this list are solutions necessary for migrating from IBM Runtimes to Oracle Runtimes. 
+* [org.openrewrite.java.migrate.Krb5LoginModuleClass](https://docs.openrewrite.org/recipes/java/migrate/krb5loginmoduleclass): Do not use the `com.ibm.security.auth.module.Krb5LoginModule` class. 
+* [org.openrewrite.java.migrate.RemovedPolicy](https://docs.openrewrite.org/recipes/java/migrate/removedpolicy): The `javax.security.auth.Policy` class is not available from Java SE 11 onwards. 
+* [org.openrewrite.java.recipes.BlankLinesAroundFieldsWithAnnotations](https://docs.openrewrite.org/recipes/java/recipes/blanklinesaroundfieldswithannotations): Fields with annotations should have a blank line before them to clearly separate them from the field above. If another field follows, it should also have a blank line after so that the field with the annotation has space on either side of it, visually distinguishing it from its neighbors. 
+* [org.openrewrite.java.spring.boot3.RelocateLauncherClasses](https://docs.openrewrite.org/recipes/java/spring/boot3/relocatelauncherclasses): Relocate classes that have been moved to different packages in Spring Boot 3.2. 
+* [org.openrewrite.java.testing.assertj.IsEqualToEmptyString](https://docs.openrewrite.org/recipes/java/testing/assertj/isequaltoemptystring): Adopt idiomatic AssertJ assertion for empty Strings. 
+
+## Changed Recipes
+
+* [org.openrewrite.gradle.ChangeDependencyClassifier](https://docs.openrewrite.org/recipes/gradle/changedependencyclassifier) was changed:
+  * Old Options:
+    * `artifactId: { type: String, required: true }`
+    * `configuration: { type: String, required: false }`
+    * `groupId: { type: String, required: true }`
+    * `newClassifier: { type: String, required: true }`
+  * New Options:
+    * `artifactId: { type: String, required: true }`
+    * `configuration: { type: String, required: false }`
+    * `groupId: { type: String, required: true }`
+    * `newClassifier: { type: String, required: false }`
+* [org.openrewrite.maven.AddRepository](https://docs.openrewrite.org/recipes/maven/addrepository) was changed:
+  * Old Options:
+    * `id: { type: String, required: true }`
+    * `layout: { type: String, required: false }`
+    * `releasesChecksumPolicy: { type: String, required: false }`
+    * `releasesEnabled: { type: Boolean, required: false }`
+    * `releasesUpdatePolicy: { type: String, required: false }`
+    * `repoName: { type: String, required: false }`
+    * `snapshotsChecksumPolicy: { type: String, required: false }`
+    * `snapshotsEnabled: { type: Boolean, required: false }`
+    * `snapshotsUpdatePolicy: { type: String, required: false }`
+    * `url: { type: String, required: true }`
+  * New Options:
+    * `id: { type: String, required: true }`
+    * `layout: { type: String, required: false }`
+    * `releasesChecksumPolicy: { type: String, required: false }`
+    * `releasesEnabled: { type: Boolean, required: false }`
+    * `releasesUpdatePolicy: { type: String, required: false }`
+    * `repoName: { type: String, required: false }`
+    * `snapshotsChecksumPolicy: { type: String, required: false }`
+    * `snapshotsEnabled: { type: Boolean, required: false }`
+    * `snapshotsUpdatePolicy: { type: String, required: false }`
+    * `type: { type: Type, required: false }`
+    * `url: { type: String, required: true }`
+* [org.openrewrite.xml.search.FindTags](https://docs.openrewrite.org/recipes/xml/search/findtags) was changed:
+  * Old Options:
+    * `xpath: { type: String, required: true }`
+  * New Options:
+    * `xPath: { type: String, required: true }`