feat: Add Gradle task to check auto-import documentation sync#7782
Draft
margaretkennedy wants to merge 1 commit intodeephaven:mainfrom
Draft
feat: Add Gradle task to check auto-import documentation sync#7782margaretkennedy wants to merge 1 commit intodeephaven:mainfrom
margaretkennedy wants to merge 1 commit intodeephaven:mainfrom
Conversation
Adds checkAutoImportDocs task to engine-table that: - Uses Java reflection to extract methods from QueryLibraryImportsDefaults.statics() - Parses markdown docs to find documented methods - Compares and reports any mismatches - Fails build if methods are missing from docs Usage: ./gradlew :engine-table:checkAutoImportDocs This is lightweight and can be added to pre-merge checks.
margaretkennedy
added
documentation
Contributor
No docs changes detected for bd4e9f7 |
margaretkennedy
changed the title
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.
Adds checkAutoImportDocs task to engine-table that:
Usage: ./gradlew :engine-table:checkAutoImportDocs
This is lightweight and can be added to pre-merge checks.
Currently: You must run the task manually
Future options:
Add check.dependsOn(checkAutoImportDocs) → runs with every ./gradlew check
Add to CI workflow → runs on every PR