Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[improve][build] Disable javadoc build failure #24594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 8, 2025
Merged

[improve][build] Disable javadoc build failure #24594

merged 1 commit into from
Sep 8, 2025

Conversation

nodece
Copy link
Member

@nodece nodece commented Jul 31, 2025

Motivation

Maven Central requires javadoc JARs, but strict Javadoc checks can fail the build. Disabling failOnError ensures minor Javadoc issues don't block the deploy process：

Error:  Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.5.0:jar (attach-javadocs) on project pulsar-broker: MavenReportException: Error while generating Javadoc: 
Error:  Exit code: 1
Error:  /home/ubuntu/actions-runner/_work/***-ci/***-ci/pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/ServerCnx.java:89: error: cannot find symbol
Error:  import org.apache.pulsar.broker.event.data.ProducerConnectEventData.ProducerConnectEventDataBuilder;
Error:                                                                     ^
Error:    symbol:   class ProducerConnectEventDataBuilder
Error:    location: class ProducerConnectEventData
Error:  /home/ubuntu/actions-runner/_work/***-ci/***-ci/pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/TopicEventsDispatcher.java:164: error: cannot find symbol
Error:          private final EventContext.EventContextBuilder builder;
Error:                                    ^
Error:    symbol:   class EventContextBuilder
Error:    location: class EventContext
Error: [ERROR] 2 errors
Error:  Command line was: /home/ubuntu/actions-runner/_work/_tool/Java_Temurin-Hotspot_jdk/17.0.14-7/x64/bin/javadoc @options @packages
Error:  
Error:  Refer to the generated Javadoc files in '/home/ubuntu/actions-runner/_work/***-ci/***-ci/pulsar/pulsar-broker/target/apidocs' dir.
Error:  -> [Help 1]

Modifications

  • Added <failOnError>false</failOnError> to maven-javadoc-plugin configuration

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@nodece nodece requested review from dao-jun and lhotari July 31, 2025 09:15
@nodece nodece self-assigned this Jul 31, 2025
@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Jul 31, 2025
@lhotari
Copy link
Member

lhotari commented Jul 31, 2025

Maven Central requires javadoc JARs, but strict Javadoc checks can fail the build. Disabling failOnError ensures minor Javadoc issues don't block the deploy process：

@nodece Just wondering why we aren't facing this when we do the OSS Pulsar release.

@nodece
Copy link
Member Author

nodece commented Jul 31, 2025

@lhotari This issue occurs when importing a builder class generated by lombok, as Javadoc cannot resolve symbols for generated code during the deploy.

@nodece nodece closed this Aug 1, 2025
@nodece nodece reopened this Aug 1, 2025
@nodece
Copy link
Member Author

nodece commented Aug 6, 2025

Ping @lhotari

@nodece nodece force-pushed the disable-java-doc-build-failure branch from cbce3ca to 933778e Compare August 27, 2025 03:11
@nodece nodece force-pushed the disable-java-doc-build-failure branch from 933778e to 2619bdd Compare September 8, 2025 13:08
@nodece nodece added this to the 4.2.0 milestone Sep 8, 2025
@codecov-commenter
Copy link

codecov-commenter commented Sep 8, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.15%. Comparing base (0a949de) to head (2619bdd).
⚠️ Report is 43 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #24594      +/-   ##
============================================
- Coverage     74.29%   74.15%   -0.15%     
- Complexity    33140    33451     +311     
============================================
  Files          1895     1895              
  Lines        147979   147979              
  Branches      17137    17137              
============================================
- Hits         109942   109728     -214     
- Misses        29317    29492     +175     
- Partials       8720     8759      +39
Flag Coverage Δ
inttests 26.26% <ø> (-0.32%) ⬇️
systests 22.60% <ø> (-0.23%) ⬇️
unittests 73.68% <ø> (-0.12%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 79 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nodece nodece merged commit 783172f into apache:master Sep 8, 2025
50 checks passed
@nodece nodece deleted the disable-java-doc-build-failure branch September 8, 2025 14:23
lhotari pushed a commit that referenced this pull request Sep 8, 2025
@nodece @lhotari
[improve][build] Disable javadoc build failure (#24594)
ec0df9c 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
Technoboy- pushed a commit that referenced this pull request Sep 10, 2025
@nodece @Technoboy-
[improve][build] Disable javadoc build failure (#24594)
1e84fa7 
Signed-off-by: Zixuan Liu <[email protected]>
lhotari pushed a commit that referenced this pull request Sep 11, 2025
@nodece @lhotari
[improve][build] Disable javadoc build failure (#24594)
66295c6 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
lhotari pushed a commit that referenced this pull request Sep 11, 2025
@nodece @lhotari
[improve][build] Disable javadoc build failure (#24594)
26a31ac 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
manas-ctds pushed a commit to datastax/pulsar that referenced this pull request Sep 12, 2025
@nodece @manas-ctds
[improve][build] Disable javadoc build failure (apache#24594)
472c4ad 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 1e84fa7)
nborisov pushed a commit to nborisov/pulsar that referenced this pull request Sep 12, 2025
@nodece
[improve][build] Disable javadoc build failure (apache#24594)
2636426 
Signed-off-by: Zixuan Liu <[email protected]>
srinath-ctds pushed a commit to datastax/pulsar that referenced this pull request Sep 12, 2025
@nodece @srinath-ctds
[improve][build] Disable javadoc build failure (apache#24594)
25ef3d6 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 1e84fa7)
ganesh-ctds pushed a commit to datastax/pulsar that referenced this pull request Sep 15, 2025
@nodece @ganesh-ctds
[improve][build] Disable javadoc build failure (apache#24594)
fb253ab 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
(cherry picked from commit 26a31ac)
ganesh-ctds pushed a commit to datastax/pulsar that referenced this pull request Sep 15, 2025
@nodece @ganesh-ctds
[improve][build] Disable javadoc build failure (apache#24594)
fbf95c8 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
(cherry picked from commit 26a31ac)
srinath-ctds pushed a commit to datastax/pulsar that referenced this pull request Sep 15, 2025
@nodece @srinath-ctds
[improve][build] Disable javadoc build failure (apache#24594)
ca51b8e 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
(cherry picked from commit 26a31ac)
nodece added a commit to nodece/pulsar that referenced this pull request Sep 16, 2025
@nodece
[improve][build] Disable javadoc build failure (apache#24594)
6da7d8f 
Signed-off-by: Zixuan Liu <[email protected]>
(cherry picked from commit 783172f)
KannarFr pushed a commit to CleverCloud/pulsar that referenced this pull request Sep 22, 2025
@nodece @KannarFr
[improve][build] Disable javadoc build failure (apache#24594)
151208c 
Signed-off-by: Zixuan Liu <[email protected]>
walkinggo pushed a commit to walkinggo/pulsar that referenced this pull request Oct 8, 2025
@nodece @walkinggo
[improve][build] Disable javadoc build failure (apache#24594)
1afa91c 
Signed-off-by: Zixuan Liu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dao-jun dao-jun dao-jun approved these changes

@coderzc coderzc coderzc approved these changes

@lhotari lhotari Awaiting requested review from lhotari

Assignees

@nodece nodece

Labels

cherry-picked/branch-3.0 cherry-picked/branch-3.3 cherry-picked/branch-4.0 cherry-picked/branch-4.1 doc-not-needed Your PR changes do not impact docs release/3.0.14 release/3.3.9 release/4.0.7 release/4.1.1

Projects

None yet

Milestone

4.2.0

Development

Successfully merging this pull request may close these issues.

6 participants

@nodece @lhotari @codecov-commenter @dao-jun @coderzc @Technoboy-