Skip to content
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

Merged
merged 9 commits into from
May 26, 2023

Conversation

austintlee
Copy link
Contributor

@austintlee austintlee commented May 17, 2023

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
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.remotestore.SegmentReplicationRemoteStoreIT.testReplicaHasDiffFilesThanPrimary
      1 org.opensearch.index.remote.RemoteRefreshSegmentPressureServiceTests.testValidateSegmentUploadLag

@codecov
Copy link

codecov bot commented May 17, 2023

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

Copy link
Member

@dblock dblock left a 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.

Copy link
Member

@dblock dblock left a 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.

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@dblock
Copy link
Member

dblock commented May 23, 2023

Add to CHANGELOG?

We got to get gradle checks to pass on main :(

Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
server/build.gradle Outdated Show resolved Hide resolved
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.search.backpressure.SearchBackpressureIT.testSearchShardTaskCancellationWithHighCpu

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: Austin Lee <austin.t.lee@gmail.com>
@reta 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
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.search.backpressure.SearchBackpressureIT.testSearchShardTaskCancellationWithHighCpu

@reta reta merged commit 0921ad7 into opensearch-project:main May 26, 2023
@reta
Copy link
Collaborator

reta commented May 26, 2023

Thanks a lot @austintlee !

@opensearch-trigger-bot
Copy link
Contributor

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.

reta pushed a commit to reta/OpenSearch that referenced this pull request May 26, 2023
…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)
reta added a commit that referenced this pull request May 26, 2023
…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>
suranjay pushed a commit to suranjay/OpenSearch that referenced this pull request May 29, 2023
…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>
stephen-crawford pushed a commit to stephen-crawford/OpenSearch that referenced this pull request May 31, 2023
…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>
austintlee added a commit to austintlee/OpenSearch that referenced this pull request Jun 2, 2023
…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>
gaiksaya pushed a commit to gaiksaya/OpenSearch that referenced this pull request Jun 26, 2023
…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>
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MissingJavaDoc checker to support * for ignoring group of files
3 participants