Skip to content

Aggregated Javadoc no longer published since 7.0.0-M4 #34774

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
bclozel opened this issue Apr 17, 2025 · 1 comment
Closed

Aggregated Javadoc no longer published since 7.0.0-M4 #34774

bclozel opened this issue Apr 17, 2025 · 1 comment
Assignees
@sbrannen
Labels
type: documentation A documentation task type: regression A bug that is also a regression
Milestone
7.0.0-M5

Comments

@bclozel
Copy link
Member

bclozel commented Apr 17, 2025 •
edited by sbrannen
Loading

This is a regression that was introduced in #27497.

Although we compile sources with a Java 24 toolchain (targeting Java 17 bytecode), we are still using Java 17 to run the Gradle build.
@bclozel bclozel added the type: regression A bug that is also a regression label Apr 17, 2025
@bclozel bclozel added this to the 7.0.0-M5 milestone Apr 17, 2025
@mp911de mp911de mentioned this issue Apr 17, 2025
Closed
sbrannen added a commit that referenced this issue Apr 17, 2025
@sbrannen
Configure JDK 24 toolchain for aggregated Javadoc
49ef150 
Changes made in conjunction with #27497 now require that we generate
Javadoc with JDK 18 or higher in order to make use of the
"--link-modularity-mismatch" flag for the javadoc executable.

This commit sets the toolchain for the javadoc task in the
framework-api module to use JDK 24 for generating Javadoc.

The common javadoc task used by all spring-* modules will be addressed
in a separate commit.

See gh-27497
See gh-34774
@sbrannen sbrannen added the type: documentation A documentation task label Apr 17, 2025
@sbrannen sbrannen changed the title Reinstate missing Javadoc in 7.0.0-M4 Javadoc no longer published since 7.0.0-M4 Apr 17, 2025
@sbrannen sbrannen changed the title Javadoc no longer published since 7.0.0-M4 Aggregated Javadoc no longer published since 7.0.0-M4 Apr 17, 2025
@sbrannen
Copy link
Member

In commit 49ef150, I stated that the common javadoc task used by all spring-* modules would be addressed in a separate commit. However, after further investigation I determined that the spring-test Javadoc JAR was published successfully, including links to JUnit 5 Javadoc (which was not previously the case).

The reason is that the javadoc task automatically uses the toolchain configured by our JavaConventions plugin for each spring-* project.

So, it was just the aggregated Javadoc in the framework-api project that did not get generated/published for 7.0.0-M4, and commit 49ef150 already ensures that the javadoc task for the framework-api project has its toolchain set to Java 24 like JavaConventions does.

@sbrannen sbrannen mentioned this issue Apr 27, 2025
Closed
sbrannen added a commit that referenced this issue Apr 27, 2025
@sbrannen
Fail Gradle build whenever a javadoc task fails
5013d6d 
To ensure that failures in javadoc tasks do not result in documentation
silently not being generated/published, this commit sets
`failOnError = true` for all javadoc tasks.

See gh-27497
See gh-34774
Closes gh-34837
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@sbrannen sbrannen

Labels
type: documentation A documentation task type: regression A bug that is also a regression
Projects
None yet
Milestone
7.0.0-M5
Development

No branches or pull requests
2 participants
@bclozel @sbrannen