Enabling missingJavadoc validation in CI with gradle check #721
Conversation
Excludes modules currently failing from missingJavadoc check. These modules can be removed from exclusion list once javadocs are added. Currently, only :client:rest module is enabled for missingJavadoc check. Issue opensearch-project#221 tracks javadocs for legacy code. These checks are enabled as part of gradle check. Enabling it as part of precommit needs more work and will be done later. Once this PR is merged all incoming PRs will undergo javadoc validations. Signed-off-by: Himanshu Setia <[email protected]>
setiah
changed the title
|
start gradle check |
|
✅ DCO Check Passed 7996a8e |
|
✅ Gradle Wrapper Validation success 7996a8e |
|
✅ Gradle Precommit success 7996a8e |
| project(":test:fixtures:s3-fixture"), | ||
| project(":test:framework"), | ||
| project(":test:logger-usage") | ||
| ]) { |
There was a problem hiding this comment.
This is basically everything, especially with :server. Feels like we should machine-generate JavaDoc first, or divide and conquer manually adding it, or something like that before enabling this. WDYT?
There was a problem hiding this comment.
Thanks for reviewing @dblock. I agree we should add more javadocs, and divide and conquer seems to be the right approach, given the extent. However to your point on publishing, we do have machine generated javadocs today on opensearch website. Enabling this check will not break the javadoc task (used for publishing these docs on website), instead it would ensure that the modules that have been fixed (like client:rest #685) do not break again.
There was a problem hiding this comment.
Open an issue for missing JavaDoc when merging and link to this conversation?
There was a problem hiding this comment.
Open an issue for missing JavaDoc when merging and link to this conversation?
Already there :) #221
This PR enables missingJavadoc validation as part of gradle check.
It excludes modules currently failing from missingJavadoc check from validation so tht they don't gradle check. These modules can be removed from exclusion list once javadocs are added. Currently, only :client:rest module is enabled for missingJavadoc check. Issue #221 tracks javadocs for legacy code.
These checks are enabled as part of gradle check. Enabling it as part of precommit needs more work and will be done later.
Once this PR is merged all incoming PRs will undergo javadoc validations. This will prevent any new module that is without javadocs from getting added as the gradle check would fail. It will also prevent any new changes without javadocs on existing modules that are not part of exclusion list (e.g. :client:rest, thanks to #685 )
Signed-off-by: Himanshu Setia [email protected]
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.