Skip to content

Commit 8ba4176

Browse files
shanshinfzhinkin
andauthored
Added a warning about the end of development of a separate plugin (#296)
Co-authored-by: Filipp Zhinkin <filipp.zhinkin@jetbrains.com>
1 parent 49b5b55 commit 8ba4176

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44
[![License](https://img.shields.io/github/license/Kotlin/binary-compatibility-validator)](LICENSE.TXT)
55
[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlin.github.io/binary-compatibility-validator/)
66

7+
# Support for this plugin has been discontinued
8+
The development of a separate binary compatibility validator Gradle plugin has been discontinued,
9+
and all its functionality will be moved to Kotlin Gradle Plugin starting from the `2.2.0` release.
10+
11+
As part of the migration, the code of the current plugin has been migrated to [the Kotlin repository](https://github.com/JetBrains/kotlin/tree/master/libraries/tools/abi-validation),
12+
as well as issues migrated to [the Kotlin project in YouTrack](https://youtrack.jetbrains.com/issues/KT?q=subsystems:%20%7BTools.%20BCV%7D,%20%7BTools.%20Gradle.%20BCV%7D).
13+
14+
This plugin is frozen from changes, no new features or minor bugfixes will be added to it.
15+
16+
The functionality of working with the ABI in Kotlin Gradle Plugin is in an experimental state now,
17+
so it is recommended to continue using this plugin in production projects until KGP API stabilization.
18+
719
# Binary compatibility validator
820

921
The tool allows dumping binary API of a JVM part of a Kotlin library that is public in the sense of Kotlin visibilities and ensures that the public binary API wasn't changed in a way that makes this change binary incompatible.

0 commit comments

Comments
 (0)