Fail Maven build on warnings #2335
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
For the Javadoc plugin it is "warnings" (plural) instead of "warning"
| @@ -173,6 +186,7 @@ | |||
| <detectOfflineLinks>false</detectOfflineLinks> | |||
| <!-- Only show warnings and errors --> | |||
| <quiet>true</quiet> | |||
| <failOnWarnings>true</failOnWarnings> | |||
There was a problem hiding this comment.
I see this is failOnWarning for maven-compiler-plugin and failOnWarnings for maven-javadoc-plugin. Yay Maven.
| <dependencies> | ||
| <!-- Error Prone Annotations is only directly used by gson module, but since this is an optional | ||
| dependency and other modules depend on gson module they also need the dependency to avoid | ||
| compiler warnings, see comments on https://bugs.openjdk.org/browse/JDK-6331821 --> |
There was a problem hiding this comment.
So apparently this bug from 2005 is still open.
There was a problem hiding this comment.
Sorry, my fault I copied the wrong URL while browsing the bug reports... 🤦
Will create a follow-up pull request to fix that (#2338).
I meant to refer to the same JDK bug report mentioned in #2320 (comment). It looks like both reports might describe the same bug and JDK-6331821 was never closed. But I haven't tested it.
I mainly wanted to refer to that JDK bug report because its fix introduced the compiler warnings.
eamonnmcmanus
pushed a commit
that referenced
this pull request
May 31, 2023
* Fail Maven build on warnings * Fix configuration parameter name For the Javadoc plugin it is "warnings" (plural) instead of "warning"
tibor-universe
pushed a commit
to getuniverse/gson
that referenced
this pull request
Sep 14, 2024
* Fail Maven build on warnings * Fix configuration parameter name For the Javadoc plugin it is "warnings" (plural) instead of "warning"
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.
Purpose
Changes the
pom.xmlto fail when compilation and Javadoc warnings are reported, see also #2320 (comment).Description
Also moved the optional Error Prone Annotations dependency to the parent
pom.xmlto avoid compiler warnings for the other modules depending on thegsonmodule, see #2320 (comment).If you want I can revert the change to also fail on warnings for Javadoc.
Checklist
null@since $next-version$(
$next-version$is a special placeholder which is automatically replaced during release)TestCase)mvn clean verify javadoc:jarpasses without errors