ci: fix Java Javadoc aggregate so /api/java deploys#159
Merged
Conversation
The aggregate report pulled in Kotlin modules (Ktor and the compiler-plugin variants) that have no module descriptor. Mixing these unnamed modules with the named Java modules makes javadoc:aggregate fail with "named and unnamed modules"; because failOnError=false is set, the step reported success while producing no output, leaving https://orm.st/api/java a 404. - Exclude the Kotlin / non-module-path modules from the aggregate (they are documented separately as KDoc under /api/kotlin). - Require index.html in the copy step, so an empty aggregate fails the build loudly instead of silently deploying an empty /api/java.
Collaborator
Author
|
✅ Validated locally: with the new exclusions, |
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
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
https://orm.st/api/java/index.html(and the whole/api/java/tree) 404s — the Javadoc is never published, while/api/kotlin/*works.Root cause
The "Generate Javadoc (aggregate)" step in
docs.ymlfails:The aggregate pulls in Kotlin modules (Ktor + the compiler-plugin variants) that have no module descriptor.
javadoc:aggregatecan't mix these unnamed modules with the named Java modules. Because-Dmaven.javadoc.failOnError=falseis set, the step still reports success while producing no output, so the copy step deploys an empty/api/java. (Confirmed:gh-pageshas noapi/javadirectory.)Fix
-pllist:storm-ktor,storm-ktor-test, andstorm-compiler-plugin-2.0…2.4. Every remaining source module has amodule-info.java(all named), so aggregation succeeds. These Kotlin APIs are already published as KDoc under/api/kotlin.index.html(not just the directory), so a future empty/failed aggregate fails the build loudly instead of silently shipping an empty/api/java.Verification
Verified every remaining module is named (
find -name module-info.java). Running a localmvn install+javadoc:aggregatewith the new exclusions to confirmindex.htmlis produced. Once merged, the push tomaintriggers the docs deploy; with the hardened guard, if anything is still off it will fail rather than silently 404.