azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use BCV plugin to dump and check public API of Kotlin Gradle plugin-related artifacts

Browse Source
This commit is contained in:
Ilya Gorbunov
2022-11-07 18:51:22 +01:00
committed by Space Team
parent 49bd4e672b
commit 59131f8138
14 changed files with 64 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin-idea/ReadMe.md
+7 -3
View File
@@ -3,11 +3,15 @@
The classes defined in this module will be available inside the Kotlin Gradle Plugin (KGP)
as well as in the IDE import (GradleProject).
## Binary Compatibility:
## Binary Compatibility
Binary compatibility can be tested by
The public API surface of this module is checked for stability
using the [binary compatibility validator](https://github.com/Kotlin/binary-compatibility-validator/) plugin
to prevent accidental public API changes.
`./gradlew :tools:binary-compatibility-validator:clean :tools:binary-compatibility-validator:test`
You can execute public API validation by running `apiCheck` task (also executed when `check` task runs).
In order to overwrite the reference API snapshot, you can launch `apiDump` task.
Binary incompatible changes have to go through a proper deprecation cycle after releases