Skip to content

build: remove maven-javadoc-plugin skip in core-shaded#937

Merged
dkropachev merged 1 commit into
scylladb:scylla-4.xfrom
nikagra:fix/remove-javadoc-skip-core-shaded
Jun 25, 2026
Merged

build: remove maven-javadoc-plugin skip in core-shaded#937
dkropachev merged 1 commit into
scylladb:scylla-4.xfrom
nikagra:fix/remove-javadoc-skip-core-shaded

Conversation

@nikagra

@nikagra nikagra commented Jun 24, 2026

Copy link
Copy Markdown

Summary

Fixes core-shaded javadoc generation broken since deaeb1c ("build: drop Java 8 support", May 25 2026), which added <skip>true</skip> to the maven-javadoc-plugin in core-shaded/pom.xml to paper over a javadoc compilation failure introduced by the Netty 4.1.135.Final bump.

Problem

With <skip>true</skip> at the plugin level, no javadoc jar is attached for the core-shaded artifact during a release. Sonatype Central rejects the upload because javadoc jars are required for all published artifacts.

The underlying compilation failure was caused by two missing dependencies on the javadoc classpath when processing the shaded sources:

  1. org.jetbrains:annotations — Netty 4.1.135.Final added @NotNull, @VisibleForTesting, and @Async.Execute/Schedule from this package.
  2. ch.randelshofer:fastdoubleparser — Jackson 2.21.x sources reference this package, but it is bundled-and-shaded inside jackson-core with no standalone resolvable Maven coordinate.

Changes

  • Remove the <skip>true</skip> global plugin configuration.
  • Add org.jetbrains:annotations:23.0.0 to additionalDependencies in the attach-javadocs execution (same version Netty uses as a provided dependency).
  • Add <failOnError>false</failOnError> to the attach-javadocs execution to tolerate the unresolvable fastdoubleparser references. Those sources are already excluded from the javadoc output via excludePackageNames, so the jar still contains the full public API documentation.

Test plan

  • Trigger a release build and confirm the core-shaded javadoc jar is generated and accepted by Sonatype Central.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The maven-javadoc-plugin configuration in core-shaded/pom.xml previously contained <skip>true</skip>, which disabled all javadoc generation and attachment for that module. This change removes those three lines, causing the plugin to run its configured executions during the build instead of being skipped.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main build change in core-shaded.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description directly matches the change: removing the javadoc skip from core-shaded pom.xml to restore javadoc jar generation.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nikagra nikagra requested a review from dkropachev June 24, 2026 16:30
…ckson 2.21

The top-level <configuration><skip>true</skip></configuration> block was
introduced in deaeb1c ("build: drop Java 8 support", May 25 2026) to paper
over a javadoc compilation failure caused by the Netty 4.1.135.Final bump.
That version added compile-time references to org.jetbrains:annotations
(@NotNull, @VisibleForTesting, @Async.Execute/Schedule). Jackson 2.21.x
sources also reference ch.randelshofer:fastdoubleparser, which is bundled-
and-shaded inside jackson-core with no standalone resolvable Maven coordinate.

With <skip>true</skip> at the plugin level, no javadoc jar is attached for
the core-shaded artifact, causing Sonatype Central to reject the release.

Fix:
- Remove the global skip flag (the attach-javadocs execution is still in place)
- Add org.jetbrains:annotations:23.0.0 to additionalDependencies (matches
  the version Netty uses as a provided dependency)
- Set failOnError=false for the fastdoubleparser case; those sources are
  already excluded from the output via excludePackageNames, so the jar still
  contains the full public API documentation
@nikagra nikagra force-pushed the fix/remove-javadoc-skip-core-shaded branch from b58423b to 5c942b2 Compare June 24, 2026 16:56
@dkropachev dkropachev merged commit 974b884 into scylladb:scylla-4.x Jun 25, 2026
25 checks passed
@nikagra nikagra deleted the fix/remove-javadoc-skip-core-shaded branch June 25, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants