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-api/ReadMe.md
+6 -6
View File
@@ -3,11 +3,11 @@
Lightweight module defining the API surface of the Kotlin Gradle Plugin.
### Binary Compatibility Validation
This module is tested for Binary Compatibility Validation by the :tools:binary-compatibility-validator module.
Please see [ReadMe.md](../binary-compatibility-validator/ReadMe.md)
You can execute binary compatibility validation by a shared run-configuration in the IDE
`/Tests/Test: binary compatibility`
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.
In order to check in changes you can launch
`Test/Test: binary compatibility [overwrite]`
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.