Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to automate a breaking change in a library #287

Open
timtebeek opened this issue Jun 18, 2024 · 0 comments
Open

Document how to automate a breaking change in a library #287

timtebeek opened this issue Jun 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@timtebeek
Copy link
Contributor

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

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.

@timtebeek timtebeek added the enhancement New feature or request label Jun 18, 2024
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Jun 18, 2024
@timtebeek timtebeek moved this to Backlog in OpenRewrite Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant