Skip to content

Commit fa021ed

Browse files
committed
Document published dependency scope change as potentially breaking
Resolves #2705.
1 parent efb980c commit fa021ed

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

documentation/src/docs/asciidoc/release-notes/release-notes-5.8.0.adoc

+18-1
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,25 @@ on GitHub.
2727
[[release-notes-5.8.0-overall-improvements]]
2828
=== Overall Improvements
2929

30+
==== Deprecations and Breaking Changes
31+
32+
* Since the API Guardian dependency is no longer exported as a runtime but as a
33+
compile-only dependency to consuming Gradle projects, Gradle builds that define their own
34+
https://docs.gradle.org/current/userguide/declaring_dependencies.html#sec:what-are-dependency-configurations[dependency configurations]
35+
may be affected. For example, if the custom configuration is used to manipulate a source
36+
set's classpath directly, dependency attributes needed for Gradle's variant-aware
37+
dependency management are dropped and API Guardian is missing from the compile
38+
classpath. In that case, the Java compiler emits warnings which -- depending on your
39+
configured options -- may cause the build to fail. The solution is to avoid manipulating
40+
a source set's classpath directly. Instead, its dependency configurations should extend
41+
from your custom configuration. An example of such a change can be seen in
42+
https://github.com/spring-projects/spring-framework/commit/d23afea168b8360d08bf296ac2189239ab9db7fc[this commit]
43+
to the Spring Framework repository.
44+
45+
==== New Features and Improvements
46+
3047
* The API Guardian dependency is now exported as a compile-only dependency for consuming
31-
Gradle projects.
48+
Gradle projects and no longer required at runtime when running on the module path.
3249
* Logging messages are no longer issued at `INFO` level in order to lower the "textual
3350
noise" on the console when Java's Util Logging is used in its default configuration.
3451

0 commit comments

Comments
 (0)