build: fail build explicitly on Javadoc errors#24378
Conversation
Make failOnError explicit on maven-javadoc-plugin so Javadoc errors visibly break the build instead of being buried in log output.
Test Results1 209 files - 209 1 209 suites - 209 1h 18m 35s ⏱️ - 2m 41s Results for commit f34f9c3. ± Comparison against base commit eef1d26. ♻️ This comment has been updated with latest results. |
| <version>3.12.0</version> | ||
| <configuration> | ||
| <quiet>true</quiet> | ||
| <failOnError>true</failOnError> |
There was a problem hiding this comment.
Does this change anything as the Default value for failOnError is true and it does fail the build.
Maven prefixes every Javadoc tool stderr line with [ERROR], so the single real "error:" line gets lost among 100+ identically-prefixed warning lines. Grep the actual error lines out of the per-shard Maven log and write them to GITHUB_STEP_SUMMARY so they show up at the top of the failing unit-tests job. Also drops the redundant <failOnError>true</failOnError> override — that's already the maven-javadoc-plugin default.
DO NOT MERGE. Temporary broken {@link} to a non-existent class so the
unit-tests job fails with a real Javadoc error, letting us confirm the
"Surface Javadoc errors" step actually surfaces it in the PR summary.
Revert before merge.
|
At least this run doesn't actually print out any lines: |
|
|
It shows up only on the summary page it seems: Works quite well 👍 |
| * | ||
| * See {@link com.vaadin.flow.does.not.Exist} for related information. |
There was a problem hiding this comment.
| * | |
| * See {@link com.vaadin.flow.does.not.Exist} for related information. |
Remove broken javadoc
2 participants
Make failOnError explicit on maven-javadoc-plugin so Javadoc errors visibly break the build instead of being buried in log output.