`SpringModulithProcessor` from apt rewrites `javadoc.json` if application modules in different gradle modules

[ajax-semenov-y]

I have a multi-module Gradle project with application modules in different Gradle modules. I've added apt to gather Javadoc for documentation, and it runs separately for each module. However, each module overwrites the javadoc.json file content.

I'm uncertain about the best way to handle this. A solution that comes to mind is to generate a javadoc.json file in each module's build directory and then, when creating SpringModulithDocumentationSource, parse all build directories for javadoc.json files and consolidate them into one instance.

[odrotbohm]

I am not a Gradle expert, but I'd assume the APT to be executed from the folder of the Gradle module, so that the individual files end up in the build folder of that very module?

[ajax-semenov-y]

I have created a small reproduce for this issue: GitHub Repository. Please ensure you checkout the modulith-apt-demo branch.

Steps to reproduce:

• Run ./gradlew clean assemble in root

Actual result:

• The build/generated-spring-modulith/javadoc.json file contains only one record, which will be the ModuleA, ModuleB, or ModuleC class, depending on which Gradle task completed last.
• The module-a/build/generated-spring-modulith/javadoc.json and module-b/build/generated-spring-modulith/javadoc.json are not exist.

As a result, some of the Java documentation is missing because, when creating an instance of SpringModulithDocumentationSource, only the generated-spring-modulith/javadoc.json file from the root build directory is considered.

Expected result:

• The JavaDocs from all Gradle modules are aggregated, and the complete documentation is available.

P.S. I suspect that a multi-module Maven project may encounter the same issue, but I cannot confirm this.

[ajax-semenov-y]

Sorry that I forgot to mention that it's important to run ./gradlew clean assemble from the console, not from IDEA. Due to some bug in IDEA, it does not call annotation processors in submodules when executed this way (at least in my version of IDEA).

[odrotbohm]

Can you try the 1.4.0-SNAPSHOTS? Happy to backport the fix to the currently maintained branches if that helps.

[ajax-semenov-y]

Checked on 1.4.0-SNAPSHOTS - each Gradle module now has a corresponding /build/generated-spring-modulith/javadoc.json file, thanks for quick fix!

However, these files are not used by SpringModulithDocumentationSource because BuildSystemUtils.getTargetResource(METADATA_FILE), which is employed to create the SpringModulithDocumentationSource instance, points to the root. As a result, javadocs from the modules are not included in the SpringModulithDocumentationSource#metadata collection.