Add support for ignoring missing Javadoc on generated code using annotation (# 7264) by austintlee · Pull Request #7604 · opensearch-project/OpenSearch

austintlee · 2023-05-17T13:36:59Z

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

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
[x ] Commits are signed per the DCO using --signoff
[ x] Commit changes are listed out in CHANGELOG.md file (See: Changelog)

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.

github-actions · 2023-05-17T14:11:02Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/15571/
CommitID: dcf9e4f
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

github-actions · 2023-05-17T14:31:49Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationRemoteStoreIT.testReplicaHasDiffFilesThanPrimary
      1 org.opensearch.index.remote.RemoteRefreshSegmentPressureServiceTests.testValidateSegmentUploadLag

URL: https://build.ci.opensearch.org/job/gradle-check/15573/
CommitID: dea2058
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

codecov · 2023-05-17T14:41:22Z

Codecov Report

Merging #7604 (1cba0a5) into main (adf7e2c) will increase coverage by 0.05%.
The diff coverage is n/a.

@@             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

see 440 files with indirect coverage changes

dblock

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

dblock

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.

github-actions · 2023-05-23T01:58:09Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/16000/
CommitID: 31ab340
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

dblock · 2023-05-23T14:26:57Z

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

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

server/build.gradle

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

github-actions · 2023-05-26T16:59:24Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/16373/
CommitID: 777acc0

github-actions · 2023-05-26T17:29:36Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.search.backpressure.SearchBackpressureIT.testSearchShardTaskCancellationWithHighCpu

URL: https://build.ci.opensearch.org/job/gradle-check/16375/
CommitID: be1e903
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

CHANGELOG.md

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

github-actions · 2023-05-26T18:27:57Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.search.backpressure.SearchBackpressureIT.testSearchShardTaskCancellationWithHighCpu

URL: https://build.ci.opensearch.org/job/gradle-check/16379/
CommitID: 1cba0a5
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

reta · 2023-05-26T18:37:00Z

Thanks a lot @austintlee !

opensearch-trigger-bot · 2023-05-26T18:38:07Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

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 base branch is 2.x and the compare/head branch is backport/backport-7604-to-2.x.

…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) (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>

austintlee requested review from Bukhtawar, CEHENKLE, Rishikesh1159, VachaShah, anasalkouz, andrross, dblock, dreamer-89, gbbafna, kartg, kotwanikunal, mch2, nknize, owaiskazi19, reta, ryanbogan, saratvemulapalli, setiah, shwetathareja and tlfeng as code owners May 17, 2023 13:37

dblock approved these changes May 22, 2023

View reviewed changes

doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java Outdated Show resolved Hide resolved

dblock approved these changes May 22, 2023

View reviewed changes

austintlee force-pushed the issue-7264-missing-javadoc branch from dea2058 to 31ab340 Compare May 23, 2023 01:16

reta reviewed May 23, 2023

View reviewed changes

doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java Outdated Show resolved Hide resolved

austintlee force-pushed the issue-7264-missing-javadoc branch from 31ab340 to 331b690 Compare May 25, 2023 04:16

austintlee added 2 commits May 26, 2023 09:26

Undo support for wildcards for ignoring missing Javadoc.

aab48bc

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

Remove dependency on jboss from doc-tools by using class names.

777acc0

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

austintlee force-pushed the issue-7264-missing-javadoc branch from 8f455b1 to 777acc0 Compare May 26, 2023 16:28

reta reviewed May 26, 2023

View reviewed changes

server/build.gradle Outdated Show resolved Hide resolved

reta approved these changes May 26, 2023

View reviewed changes

Remove the missingJavadoc Gradle task that is no longer needed.

be1e903

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

reta reviewed May 26, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update changelog

1cba0a5

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>

reta changed the title ~~Allow wild cards for missingJavadoc (# 7264)~~ Add support for ignoring missing Javadoc on generated code using annotation (# 7264) May 26, 2023

reta added Build Libraries & Interfaces backport 2.x Backport to 2.x branch labels May 26, 2023

reta merged commit 0921ad7 into opensearch-project:main May 26, 2023

reta mentioned this pull request May 26, 2023

[Backport] [2.x] Add support for ignoring missing Javadoc on generated code using annotation (# 7264) (#7604) #7779

Merged

Xtansia mentioned this pull request May 30, 2023

[BUG] Security plugin snapshot install fails due to JAR hell #7820

Closed

cwperks mentioned this pull request May 30, 2023

[Backport 2.8] Remove dependency on javax.annotation implementation as OpenSearch now has one. opensearch-project/security#2804

Closed

khushbr mentioned this pull request May 31, 2023

Use org.jboss.spec.javax.annotation from core in place of javax.annotation opensearch-project/performance-analyzer-rca#397

Merged

5 tasks

khushbr mentioned this pull request May 31, 2023

Revert Javax annotations dependency from core opensearch-project/performance-analyzer-rca#400

Merged

5 tasks

VachaShah mentioned this pull request Jan 17, 2024

[BUG] Fix missing javadocs error for nested classes generated using protobuf #11913

Closed

Conversation

austintlee commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

github-actions bot commented May 17, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented May 17, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

codecov bot commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 23, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

dblock commented May 23, 2023

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented May 26, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented May 26, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

Uh oh!

github-actions bot commented May 26, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

reta commented May 26, 2023

Uh oh!

opensearch-trigger-bot bot commented May 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

austintlee commented May 17, 2023 •

edited

Loading

codecov bot commented May 17, 2023 •

edited

Loading