openrewrite
Document how to automate a breaking change in a library
What problem are you trying to solve?
While we have a lot of docs, most of those are on specific elements of writing recipes, whereas the bigger picture is maybe not always clear. Especially when it comes to doing an elemental step, like automating a breaking change in a library
- https://github.com/openrewrite/rewrite-maven-plugin/issues/804#issuecomment-2175598417
Describe the solution you'd like
I think it would be helpful to have a single page where we go through automating a breaking change in a library, which is a common case in both OSS and internal libs. The page can generously link out to other pages of course, but should speak to roughly the steps explained here. We could point out how to fork the rewrite-recipe-starter, add a declarative recipe that both bumps the dependency as well as apply a ChangeType recipe, add a unit test for both of those changes, and package that up and distribute it to users, with the expected commands for users to run against projects that are still using the old version of the library.
