-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for ignoring missing Javadoc on generated code using annotation (# 7264) #7604
Add support for ignoring missing Javadoc on generated code using annotation (# 7264) #7604
Conversation
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## main #7604 +/- ##
============================================
+ Coverage 70.72% 70.77% +0.05%
- Complexity 56146 56189 +43
============================================
Files 4682 4682
Lines 266102 266102
Branches 39070 39070
============================================
+ Hits 188193 188339 +146
+ Misses 61935 61832 -103
+ Partials 15974 15931 -43 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, is there a place you want to use this, maybe add as part of this PR? Also probably ok adding a CHANGELOG line, even if it's tools.
doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, is there a place you want to use this, maybe add as part of this PR? Also probably ok adding a CHANGELOG line, even if it's tools.
dea2058
to
31ab340
Compare
Gradle Check (Jenkins) Run Completed with:
|
Add to CHANGELOG? We got to get gradle checks to pass on main :( |
doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java
Outdated
Show resolved
Hide resolved
31ab340
to
331b690
Compare
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
8f455b1
to
777acc0
Compare
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
Gradle Check (Jenkins) Run Completed with:
|
Thanks a lot @austintlee ! |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-7604-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0921ad74d7cd986f1860ac34f156bec07ef9e9ae
# Push it to GitHub
git push --set-upstream origin backport/backport-7604-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x Then, create a pull request where the |
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> (cherry picked from commit 0921ad7)
…tation (# 7264) (#7604) (#7779) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> (cherry picked from commit 0921ad7) Co-authored-by: Austin Lee <austin.t.lee@gmail.com>
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
…tation (# 7264) (opensearch-project#7604) (opensearch-project#7779) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> (cherry picked from commit 0921ad7) Co-authored-by: Austin Lee <austin.t.lee@gmail.com>
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>
It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards.
Description
Allow wildcard expressions in missingJavadoc.
Related Issues
Resolves #7264
Check List
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.