docs: Fix javadoc errors that broke publishing and gate PRs on the docs build - #12
Merged
Pijukatel merged 2 commits intoJul 24, 2026
Merged
Conversation
The attach-javadocs execution in the release profile failed with two doclint errors, aborting the publish run: - StreamedLog.java used @implNote, which javadoc rejects as an unknown tag unless registered. Register the JDK-convention informational tags (apiNote, implSpec, implNote) in the maven-javadoc-plugin config. - ActorListOptions linked to ActorCollectionClient#list(ActorListOptions), which javadoc cannot resolve because list() is inherited from the generic AbstractCollectionClient with a type-substituted signature. Link to the parameterless #list reference with an explicit label so the rendered docs still show list(ActorListOptions) instead of the non-exported superclass's erased signature. Verified with `mvn -Prelease package -DskipTests -Dgpg.skip=true`: javadoc jar now builds successfully and both spots render correctly. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CjGTHyxqt7UGXC2fwSpkkP
The publish workflow failed on doclint errors that no PR check ever
exercised, because the javadoc plugin only runs in the release profile
during a release. Add a CI step to the PR workflow that builds the
javadoc jar with that same profile (tests and GPG signing skipped), so
broken {@link} references, unknown tags and other doclint errors fail
the PR instead of surfacing for the first time mid-release.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CjGTHyxqt7UGXC2fwSpkkP
github-actions
Bot
added
t-tooling
Pijukatel
changed the title
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
3 participants
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 publish workflow failed on two javadoc doclint errors (run):
@implNoteinStreamedLog.javawas rejected as an unknown tag → registered the JDK-convention tags (apiNote,implSpec,implNote) in the javadoc plugin config.{@link ActorCollectionClient#list(ActorListOptions)}couldn't be resolved (the method is inherited from a generic superclass) → linked the parameterless#listwith a label so docs still renderlist(ActorListOptions).Also adds a PR CI step that builds the javadoc jar with the same release profile (
mvn -Prelease -DskipTests -Dgpg.skip=true package, no publishing), so doclint errors fail PRs instead of surfacing mid-release.Verified locally: the release-profile build reproduced both errors before the fix and passes after.
Generated by Claude Code