Previously, the optional configuration had no usage attribute. This resulted in it using the default, JAVA_RUNTIME, which caused it to only consume the runtime produced by its dependencies and not the API. Given that the optional configuration is added to the compile classpath, this was incorrect. This commit updates the optional configuration to be configured to consume the Java API of its dependencies. The configuration has also been marked as not being for consumption. This prevents other projects attempting to consume the optional variant of a project that has the optional dependencies plugin applied and further aligns it with Gradle's built-in configurations of a similar nature. See gh-27365
Spring Framework Build
This folder contains the custom plugins and conventions for the Spring Framework build.
They are declared in the build.gradle file in this folder.
Build Conventions
Compiler conventions
The org.springframework.build.compile plugin applies the Java compiler conventions to the build.
Build Plugins
Optional dependencies
The org.springframework.build.optional-dependencies plugin creates a new optional
Gradle configuration - it adds the dependencies to the project's compile and runtime classpath
but doesn't affect the classpath of dependent projects.
This plugin does not provide a provided configuration, as the native compileOnly and testCompileOnly
configurations are preferred.
API Diff
This plugin uses the Gradle JApiCmp plugin to generate API Diff reports for each Spring Framework module. This plugin is applied once on the root project and creates tasks in each framework module. Unlike previous versions of this part of the build, there is no need for checking out a specific tag. The plugin will fetch the JARs we want to compare the current working version with. You can generate the reports for all modules or a single module:
./gradlew apiDiff -PbaselineVersion=5.1.0.RELEASE
./gradlew :spring-core:apiDiff -PbaselineVersion=5.1.0.RELEASE
The reports are located under build/reports/api-diff/$OLDVERSION_to_$NEWVERSION/.