Fail build on missing Javadocs #45
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Daniel Widdis <widdis@gmail.com>
dbwiddis
commented
Jul 12, 2022
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
peternied
reviewed
Jul 12, 2022
Signed-off-by: Daniel Widdis <widdis@gmail.com>
peternied
reviewed
Jul 12, 2022
| @@ -85,6 +93,12 @@ private DiscoveryNode getOpensearchNode() { | |||
| return opensearchNode; | |||
| } | |||
|
|
|||
| /** | |||
| * Handles a plugin request from OpenSearch. This is the first request for the transport communication and will initialize the extension and will be a part of OpenSearch bootstrap. | |||
There was a problem hiding this comment.
This is the first request
It would by very valuable to have the full lifecycle of this process documented, maybe here? Then additional parts of the process would link back to this comment with a @see annotation
There was a problem hiding this comment.
Just to give some context here. During bootstrap OpenSearch will look for any extensions available running on a different port. Once discovered, read their extensions.yml file and get the metadata of that extension.
|
Thanks for iterating on this @dbwiddis, there is a lot of surface area here and its great to get a fine tooth comb looking over it and improvement maintainability of the codebase |
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
|
Ready for review:
|
Signed-off-by: Daniel Widdis <widdis@gmail.com>
saratvemulapalli
previously approved these changes
Jul 13, 2022
Signed-off-by: Daniel Widdis <widdis@gmail.com>
|
Added back the exclusion for netty4 and added the tracking issue. So now this should be mergeable. |
saratvemulapalli
previously approved these changes
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
| * @param settings The transport settings to configure. | ||
| * @param threadPool A thread pool to use. | ||
| * @return The configured Netty4Transport object. | ||
| */ | ||
| public Netty4Transport getNetty4Transport(Settings settings, ThreadPool threadPool) { |
There was a problem hiding this comment.
For later: Can change this method to createNetty4Transport.
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
owaiskazi19
reviewed
Jul 13, 2022
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: Daniel Widdis <widdis@gmail.com>
owaiskazi19
reviewed
Jul 14, 2022
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Make a new issue for this. There are license-check plugins. |
owaiskazi19
approved these changes
Jul 14, 2022
|
saratvemulapalli
approved these changes
Jul 14, 2022
kokibas
pushed a commit
to kokibas/opensearch-sdk-java
that referenced
this pull request
Mar 17, 2023
* Fail build on missing Javadocs Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix build errors from package rename Signed-off-by: Daniel Widdis <widdis@gmail.com> * Javadocs for ActionListener Signed-off-by: Daniel Widdis <widdis@gmail.com> * Javadocs for ExtensionsRunner Signed-off-by: Daniel Widdis <widdis@gmail.com> * Replace missing-javadoc and missing-doclet with require-javadoc Signed-off-by: Daniel Widdis <widdis@gmail.com> * Doc updates based on code review. Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add javadocs for ResponseHandler classes Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add javadocs to ExtensionSettings Signed-off-by: Daniel Widdis <widdis@gmail.com> * Disable javadocStrict check on netty4 package Signed-off-by: Daniel Widdis <widdis@gmail.com> * Reenable strict doc checks on netty4, fix errors Signed-off-by: Daniel Widdis <widdis@gmail.com> * Final tweaks Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix missing Netty4 params causing failure Signed-off-by: Daniel Widdis <widdis@gmail.com> * Don't use Werror, include strict check on private javadocs if present Signed-off-by: Daniel Widdis <widdis@gmail.com> * Exclude netty4 from checks and link to tracking issue Signed-off-by: Daniel Widdis <widdis@gmail.com> * Clarify and add links on future action for temporary exclusions Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update comments per code review Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update require-javadoc version, fix get/set typo Signed-off-by: Daniel Widdis <widdis@gmail.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Daniel Widdis widdis@gmail.com
Description
Javadocs:
Excluded Netty4 code as it is here temporarily; it will be eventually published to the central repository via OpenSearch, see opensearch-project/OpenSearch#3118
Issues Resolved
Fixes #27
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.