Add support for Kotlin in binary compatibility check

gradle / kotlin-dsl-samples

Samples builds using the Gradle Kotlin DSL

https://gradle.org/kotlin/

Other

3.71k stars 434 forks source link

Add support for Kotlin in binary compatibility check #1332

Closed eskatos closed 5 years ago

eskatos commented 5 years ago

[x] Add support for Kotlin in AbstractGradleViolationRule.isOverride
[x] Add support for Kotlin in SinceAnnotationMissingRule
[x] Assess japicmp behavior over Kotlin bytecode
[x] Consider using the Kotlin compiler to produce an api jar The Kotlin compiler plugin that generates API classes couldn't be used as it works at Kotlin compilation time and can't be used after the fact.

Outcome should be a reasonable best effort check and identified follow ups.

eskatos commented 5 years ago

PR https://github.com/gradle/gradle/pull/8895

eskatos commented 5 years ago

Identified follow ups

Kotlin only
- exclude Kotlin synthetic private accessors from the check, like internal members
- consider adding org.gradle.kotlin.dsl.plugins.dsl.* to the check (not part of the distribution)
- consider parameter name changes as breaking
Both Java and Kotlin
- consider nullability changes as breaking

JLLeitschuh commented 5 years ago

exclude Kotlin synthetic private accessors from the check, like internal members

You need to ensure you don't exclude methods annotated with the Kotlin annotation @PublicAPI

consider nullability changes as breaking

Going from null returning to non-null returning shouldn't be a breaking change. Going from non-null accepting to null accepting shouldn't be a breaking change.

eskatos commented 5 years ago

Good points @JLLeitschuh. I assume you meant @PublishedApi

JLLeitschuh commented 5 years ago

Yes, exactly! Thanks.

eskatos commented 5 years ago

Another follow up: typealiases used in function signatures aren't handled

eskatos commented 5 years ago

Closing as delivered in https://github.com/gradle/gradle/pull/8895