Improve error logging for recipe validation failures by including recipe name#423
Merged
timtebeek merged 2 commits intoopenrewrite:mainfrom Dec 15, 2025
Merged
Improve error logging for recipe validation failures by including recipe name#423timtebeek merged 2 commits intoopenrewrite:mainfrom
timtebeek merged 2 commits intoopenrewrite:mainfrom
Conversation
timtebeek
approved these changes
Dec 15, 2025
Member
timtebeek
left a comment
There was a problem hiding this comment.
Thanks for picking this up @RaoPrashanth ! Should help others troubleshoot more effectively
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's changed?
Improved error logging for recipe validation failures by including the recipe name in the error message. When recipe validation fails, the error log now shows which specific recipe caused the validation error, making it much easier to debug configuration issues.
Before:
After:
What's your motivation?
When recipe validation errors occur, the previous error messages didn't indicate which recipe was causing the problem. This made debugging difficult, especially in builds with multiple active recipes. By adding the recipe name to the error message, developers can immediately identify the problematic recipe without having to guess or step through code.
This improvement enhances the developer experience by providing clearer, more actionable error messages.
Anything in particular you'd like reviewers to focus on?
Anyone you would like to review specifically?
N/A
Have you considered any alternatives or workarounds?
Alternative considered: Including the full recipe descriptor with all options, but this would make the error message too verbose. The recipe name provides the essential context needed for debugging while keeping the message concise.
Any additional context
This is a small quality-of-life improvement that doesn't change any functionality - it only enhances the error reporting to make troubleshooting easier.
Checklist