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

Merging javadoc feature branch changes to main #715

Merged
merged 7 commits into from
May 18, 2021

Conversation

setiah
Copy link
Contributor

@setiah setiah commented May 17, 2021

Description

This PR merges changes in javadoc feature branch to main branch. It includes -

  1. A new gradle plugin to validate missing javadocs
  2. Fix for precommit task failure due to addition of new plugin. (PR Fixes precommit task configuration failures due to newly added missin… #707)
  3. Fix Javadoc errors in module :client:rest (PR Fix Javadoc errors in module client/rest #685)
  4. Updates CONTRIBUTING.md

Issues Resolved

#449 , #221

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

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.

Signed-off-by: Himanshu Setia [email protected]

Himanshu Setia and others added 5 commits April 11, 2021 23:28
Use `./gradlew missingJavadoc` to validate missing javadocs.
Currently this task fails because several modules are missing
appropriate javadocs. Once added, this should pass.
Also, precommit PomValidation check currently fails with missing Javadoc
plugin, that needs to be fixed -
opensearch-project#449
Thus keeping this in a separate feature branch.

Signed-off-by: Himanshu Setia <[email protected]>
* Fix Javadoc errors in client/rest module

Signed-off-by: Gregor Zurowski <[email protected]>

* Add package info file in client/rest module

Signed-off-by: Gregor Zurowski <[email protected]>

* Fix typos

Signed-off-by: Gregor Zurowski <[email protected]>

* Add exception documentation to Javadoc

Signed-off-by: Gregor Zurowski <[email protected]>
opensearch-project#707)

* Fixes precommit task configuration failures due to newly added missingJavadoc task

Signed-off-by: Himanshu Setia <[email protected]>

* Fixes javadoc task errors due to PR#685

Signed-off-by: Himanshu Setia <[email protected]>
Signed-off-by: Himanshu Setia <[email protected]>
@setiah setiah added the javadocs Anything related to javadocs label May 17, 2021
@setiah setiah requested a review from nknize May 17, 2021 20:20
@setiah setiah closed this May 17, 2021
Signed-off-by: Himanshu Setia <[email protected]>
@setiah setiah reopened this May 17, 2021
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success f218934

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed f218934

@setiah setiah mentioned this pull request May 17, 2021
5 tasks
Signed-off-by: Himanshu Setia <[email protected]>
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success f218934

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 7ee64c0

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 7ee64c0

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 7ee64c0

@@ -30,6 +30,8 @@

apply plugin: 'opensearch.java'

group = 'hdfs'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the name of the group fine? The above 2 names are fixture.xxx, but these 2 names without the fixture prefix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that discrepancy exists from the legacy codebase. The imports inside hdfs module use package name as hdfs unlike other fixture modules. Probably we can fix the hdfs module in a separate PR.

Copy link
Contributor

@gzurowski gzurowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@setiah
Copy link
Contributor Author

setiah commented May 18, 2021

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 7ee64c0
Log 186

Reports 186

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
javadocs Anything related to javadocs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants