Check the javadoc on every push - #174
Merged
Merged
Conversation
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.
The javadoc is generated only by the
releaseprofile, which runs atdeploy— on pushes todevelopand when a release is published. A malformed comment therefore fails the publish, after the GitHub release is already tagged and public, leaving a release that points at nothing on Maven Central.Maven Central itself does not inspect the javadoc: it requires a
-javadoc.jarto be present and explicitly says it does not evaluate the contents, allowing even a placeholder jar. What fails is our own build, becausedoclintis set toall,-missingin the pom. That setting is worth keeping — it catches broken{@link}s and malformed HTML — so it should be checked where the comment is written rather than at publication.A separate workflow rather than a step in
build.yml, so the failing check names itself in the pull request. Tests are compiled but not run;build.ymlis unchanged.Both
javadoc:javadocandjavadoc:test-javadocpass on this branch today.