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

[BUG] javadoc warnings not causing failures #5996

Merged
merged 1 commit into from
Jan 25, 2023

Conversation

reta
Copy link
Collaborator

@reta reta commented Jan 24, 2023

Signed-off-by: Andriy Redko andriy.redko@aiven.io

Description

javadoc warnings not causing failures

Issues Resolved

Closes #5995

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
  • 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.

@andrross
Copy link
Member

It works!

/home/runner/work/OpenSearch/OpenSearch/server/src/main/java/org/opensearch/index/shard/IndexShard.java:1692: warning: no description for @throws
     * @throws IOException

       ^
> Task :server:javadoc
/home/runner/work/OpenSearch/OpenSearch/server/src/main/java/org/opensearch/index/shard/IndexShard.java:1693: warning: no description for @throws
     * @throws InterruptedException
       ^
/home/runner/work/OpenSearch/OpenSearch/server/src/main/java/org/opensearch/index/shard/IndexShard.java:1694: warning: no description for @throws
     * @throws TimeoutException
       ^

@reta
Copy link
Collaborator Author

reta commented Jan 24, 2023

It works!

I will fix that tomorrow :) thanks @andrross !

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
@@ -40,6 +40,11 @@ opensearchplugin {
classname 'org.opensearch.painless.PainlessModulePlugin'
}

ext {
// Do not fail on `javadoc` warning (ANTLR generated code)
failOnJavadocWarning = false
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@andrross the lang-painless is a problem at the moment (I will try to find a better way in #4541), but TLDR; - ANTLR generated javadocs are full of warnings, we cannot modify these code

@@ -515,7 +515,7 @@ public void setNextDocId(int docId) throws IOException {
}

/**
* Set the {@link #size()} and ensure that the {@link #values} array can
* Set the {@link #size()} and ensure that the internal values array can
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

{@link #values} - javadoc complains (for a reason) that private final values is not accessible, makes sense.

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.indices.replication.SegmentReplicationRelocationIT.testStartReplicaAfterPrimaryIndexesDocs
      1 org.opensearch.cluster.allocation.AwarenessAllocationIT.testThreeZoneOneReplicaWithForceZoneValueAndLoadAwareness

@andrross andrross added the backport 2.x Backport to 2.x branch label Jan 25, 2023
@andrross
Copy link
Member

image

Unrelated to this PR, but my change from yesterday seems to work and we can now safely add the backport labels before the PR is merged

@andrross andrross merged commit 665ec6c into opensearch-project:main Jan 25, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 25, 2023
Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
(cherry picked from commit 665ec6c)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
andrross pushed a commit that referenced this pull request Jan 25, 2023
Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
(cherry picked from commit 665ec6c)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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.

[BUG] javadoc warnings not causing failures
2 participants