Repository navigation
CI: javac lint and javadoc doclint checks - #15
Merged
Merged
Conversation
A new `lint` job (JDK 21) runs `mvn -P lint test-compile javadoc:javadoc`: main and test sources compile with -Xlint:all and fail on any warning, and javadoc runs with doclint (every group but `missing`) and fails on any warning, so a broken reference or bad HTML in a doc comment fails the PR instead of shipping in the Maven Central javadoc jar. The settings live in a `lint` profile, so the JDK 11/17/21 test matrix is unchanged. MillionSendException now declares serialVersionUID (the only -Xlint finding), set to the value the JVM already computed for it, so its serialized form is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What CI now runs
A new
lintjob (JDK 21) next to the unchanged JDK 11/17/21testmatrix runsmvn -B -ntp -P lint test-compile javadoc:javadoc:-Xlint:allas errors (failOnWarning) on main and test sources.all,-missing,failOnWarnings): a broken{@link}, malformed HTML or a bad tag fails the PR. The release profile builds the javadoc jar with doclint off, where a broken{@link}is only a warning and the jar ships anyway (checked).missingis excluded because getters and builder methods have no doc comments.Both live in a new
lintMaven profile, so plainmvn verify(test matrix, release) is unaffected. Run it locally withmvn -P lint test-compile javadoc:javadoc.Code change
MillionSendExceptiondeclaresserialVersionUID = -5469809787528467192L. This was the only-Xlint:allfinding ([serial]). The value is the one the JVM already computed for the class (checked withserialveragainst the published 0.8.0 jar), so the serialized form is unchanged. It is a private field, so the API is unchanged.Not added
--skip-*flag, mostly by putting each argument of the compacthttp.request(...)calls on its own line. palantir-java-format uses 4-space indentation, and this code uses 2.🤖 Generated with Claude Code