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

Fixes precommit task configuration failures due to newly added missin… #707

Merged
merged 2 commits into from
May 17, 2021

Conversation

setiah
Copy link
Contributor

@setiah setiah commented May 14, 2021

Fixes precommit task configuration failures due to newly added missingJavadoc task. Also fixes bug (2 errors) in #685 causing javadoc generation failures.

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

Description

The missingJavadoc task was interfering with gradle configuration lifecycle, causing the precommit tasks to be initialized incorrectly. This caused PomValidationTask to fail as it was unable to find pom files in the configured path. This PR fixes those configuration failures.

Issues Resolved

#449

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.

Himanshu Setia added 2 commits May 14, 2021 14:47
@setiah
Copy link
Contributor Author

setiah commented May 14, 2021

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 90cbbd4

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 90cbbd4

@setiah setiah mentioned this pull request May 15, 2021
5 tasks
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 90cbbd4
Log 181

Reports 181

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 90cbbd4

@setiah setiah requested a review from nknize May 15, 2021 01:31
@setiah setiah self-assigned this May 15, 2021
@setiah setiah added the javadocs Anything related to javadocs label May 15, 2021
@setiah
Copy link
Contributor Author

setiah commented May 15, 2021

If I can get an approval here, I will merge this and raise another PR for merging the javadoc feature branch into main. This will help in channeling all incoming new javadoc contributions directly into main branch.

@setiah setiah requested a review from dblock May 15, 2021 01:38
Copy link
Collaborator

@nknize nknize 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 setiah merged commit 12cc217 into opensearch-project:javadoc May 17, 2021
setiah added a commit that referenced this pull request May 18, 2021
* Adds a gradle plugin to validate missing javadocs

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 -
#449
Thus keeping this in a separate feature branch.

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

* Fix Javadoc errors in module `client/rest` (#685)

* 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]>

* Fixes precommit task configuration failures due to newly added missin… (#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]>

* Updated CONTRIBUTING.md for info on javadocs

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

* Correcting licenses and naming

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

* Correcting version info

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

Co-authored-by: Gregor Zurowski <[email protected]>
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.

3 participants