Skip to content

Highlight the warning in README #297

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2025
Merged

Highlight the warning in README #297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@
[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlin.github.io/binary-compatibility-validator/)

# Support for this plugin has been discontinued
The development of a separate binary compatibility validator Gradle plugin has been discontinued,
and all its functionality will be moved to Kotlin Gradle Plugin starting from the `2.2.0` release.

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),
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).

This plugin is frozen from changes, no new features or minor bugfixes will be added to it.

The functionality of working with the ABI in Kotlin Gradle Plugin is in an experimental state now,
so it is recommended to continue using this plugin in production projects until KGP API stabilization.
> [!WARNING]
> The development of a separate binary compatibility validator Gradle plugin has been discontinued,
> and all its functionality will be moved to Kotlin Gradle Plugin starting from the `2.2.0` release.
>
> 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),
> 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).
>
> This plugin is frozen from changes, no new features or minor bugfixes will be added to it.
>
> The functionality of working with the ABI in Kotlin Gradle Plugin is in an experimental state now,
> so it is recommended to continue using this plugin in production projects until KGP API stabilization.

# Binary compatibility validator

Expand Down