Generate plugin reference docs and deploy via GitHub Pages#436
Merged
Generate plugin reference docs and deploy via GitHub Pages#436
Conversation
Extend DocumentationSyncTest to generate a Markdown reference page from RewriteExtension Javadoc and task descriptions. Configure the Javadoc task for full API docs, and add a GitHub Pages workflow to publish both.
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
1 participant
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
DocumentationSyncTestto generate a Markdown plugin reference page (docs/plugin-reference.md) fromRewriteExtensionJavadoc and task descriptions, covering all 14 configuration properties and 3 tasksbuild.gradle.ktswith proper title and API links for full HTML API documentation.github/workflows/pages.yml) that publishes both the curated Markdown reference and full Javadoc on version tags, mirroring the approach used in rewrite-maven-pluginTest plan
./gradlew :plugin:test --tests "org.openrewrite.gradle.DocumentationSyncTest"passes./gradlew :plugin:javadocgenerates HTML output