SK-3002 fix javadoc links blocking the flowvault public release - #400
Merged
Conversation
BulkTokenizeRequestRecord's class comment linked {@link BulkInsertRecord}
and {@link InsertRecord}; neither type exists - the real names are
BulkInsertRequestRecord and InsertRequestRecord. JDK doclint treats an
unresolvable @link as an error, so maven-javadoc-plugin exited 1 and the
flowvault/v1.0.0 release failed at attach-javadocs before deploy ran.
Internal releases pass -Dmaven.javadoc.skip=true, so javadoc is never
built on that path; public releases must not skip it because Sonatype
rejects a bundle with no -javadoc.jar. That is why a broken doc link was
invisible until the first real public release.
Verified with 'mvn -pl flowvault -am javadoc:jar': fails on the two
errors before this change, BUILD SUCCESS after.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
|
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #400 +/- ##
==========================================
Coverage 91.30% 91.30%
- Complexity 0 454 +454
==========================================
Files 157 157
Lines 6392 6392
Branches 850 850
==========================================
Hits 5836 5836
Misses 364 364
Partials 192 192
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
Problem
flowvault/v1.0.0— the first real public release — failed atPublish package(run 30826092656):Neither type exists. The real names are
BulkInsertRequestRecordandInsertRequestRecord— the doc comment droppedRequestfrom both. JDK doclint treats an unresolvable@linkas an error (not a warning), somaven-javadoc-plugin:jar (attach-javadocs)exited 1.javadoc:jarbinds topackage, which runs beforedeploy, so nothing was published — the upload never happened and nothing reached the Central Portal. No immutable state to clean up.Why it was invisible until now
Internal releases publish with
-Dmaven.javadoc.skip=true, so javadoc is never built on that path. Public releases must not skip it, because Sonatype rejects a bundle with no-javadoc.jar. So a broken doc link can only surface on a real public release — which is exactly what happened.The earlier
flowvault/v0.0.xrehearsals did runjavadoc:jar, but were cut before this class existed.Fix
One line — correct the two class names. No functional change; comment only.
Verification
BUILD FAILURE, the same twoerror: reference not foundas CIBUILD SUCCESS— javadoc jar builds forskyflow,commonandskyflow-flowvault-javaVerified on JDK 17 (no JDK 11 available locally; the release runs 11). The
reference not founddoclint check is identical across both, but a JDK 11 confirmation from CI is worth having.Re-releasing after merge
Re-running the failed job alone won't work — it checks out the same
flowvault/v1.0.0tag and rebuilds the same broken source. The tag needs to move to the fixed commit, or a new tag + Release cut.The bump side is already safe:
4534e58 [AUTOMATED] Public Release - 1.0.0is onmainwithflowvault/pom.xmlat1.0.0, so on retry theCommit changesstep takes thepom already at the target version - nothing to commitpath and exits 0.Follow-ups (not in this PR)
mvn -pl <module> -am javadoc:jartopr.yml/pr-flowvault.ymlwould move it left.warning: no @param/no @returnon the newSkyflow.builder()timeout/retry methods (timeout,connectTimeout,readTimeout,writeTimeout,maxRetries). Warnings only — they did not fail the build — but worth documenting since they are new public API.🤖 Generated with Claude Code