Fix documentation example for maven.AddPlugin #4036
Merged
Conversation
This file contains 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
The <executions> element has to be included by the user, as is made clear in the AddPluginTest: https://github.com/openrewrite/rewrite/blob/main/rewrite-maven/src/test/java/org/openrewrite/maven/AddPluginTest.java#L125-L139
|
Appreciate the immediate fix! Should prevent others from stumbling over this issue with our docs. |
timtebeek
added
bug
timtebeek
approved these changes
Feb 23, 2024
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?
Fix documentation example for maven.AddPlugin
What's your motivation?
The element has to be included by the user, as is made clear in AddPluginTest: https://github.com/openrewrite/rewrite/blob/main/rewrite-maven/src/test/java/org/openrewrite/maven/AddPluginTest.java#L125-L139
Any additional context
One could possibly argue that the documentation is correct, but the implementation is wrong; but the implementation follows the same convention used by the other parameters (
configurationanddependencies).