Include generated Gradle plugin documentation#485
Merged
Conversation
Replace the hand-written bullet-list property descriptions with the comprehensive table generated from Javadoc, adding coverage for previously undocumented properties (checkstyleConfigFile, enableExperimentalGradleBuildScriptParsing, failOnInvalidActiveRecipes, logCompilationWarningsAndErrors, throwOnParseFailures, rewriteVersion). Also add a link to the auto-generated Javadoc. Closes #484
Add a Python script that fetches the generated properties table from rewrite-gradle-plugin's docs/plugin-reference.md and replaces the content between markers in gradle-plugin-configuration.md. Integrate this into the existing update-docs workflow so it runs on every scheduled or manual update.
mike-solomon
approved these changes
Apr 13, 2026
Contributor
mike-solomon
left a comment
mike-solomon
left a comment
There was a problem hiding this comment.
Nice! This looks great.
github-project-automation
bot
moved this from In Progress
to Ready to Review
in OpenRewrite
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
2 participants
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.
Summary
Replace hand-written bullet-list property descriptions with a comprehensive table sourced from the generated plugin reference
Add coverage for previously undocumented properties:
checkstyleConfigFile,enableExperimentalGradleBuildScriptParsing,failOnInvalidActiveRecipes,logCompilationWarningsAndErrors,throwOnParseFailures,rewriteVersionAdd link to the auto-generated Javadoc
Closes Include the generated Gradle plugin documentation #484
Test plan
npm run buildsucceeds