Add binary API validation (#53)

ajalt · Feb 29, 2024 · 5f3745c · 5f3745c
1 parent a390682
commit 5f3745c
Show file tree

Hide file tree

Showing 8 changed files with 1,638 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,6 +21,7 @@ jobs:
         include:
           - os: ubuntu-latest
             GRADLE_ARGS: |
+              apiCheck
               :test:check
               :colormath:compileKotlinLinuxArm64
               :colormath:compileKotlinWasmJs

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -13,8 +13,17 @@ plugins {
     alias(libs.plugins.dokka).apply(false)
     alias(libs.plugins.publish).apply(false)
     alias(libs.plugins.compose).apply(false)
+    alias(libs.plugins.kotlinBinaryCompatibilityValidator)
 }
 
+apiValidation {
+    // https://github.com/Kotlin/binary-compatibility-validator/issues/3
+    project("scripts").subprojects.mapTo(ignoredProjects) { it.name }
+    project("test").subprojects.mapTo(ignoredProjects) { it.name }
+    project("website").subprojects.mapTo(ignoredProjects) { it.name }
+}
+
+
 fun getPublishVersion(): String {
     val versionName = project.property("VERSION_NAME") as String
 

diff --git a/colormath/api/colormath.api b/colormath/api/colormath.api
diff --git a/extensions/colormath-ext-android-color/api/colormath-ext-android-color.api b/extensions/colormath-ext-android-color/api/colormath-ext-android-color.api
@@ -0,0 +1,6 @@
+public final class com/github/ajalt/colormath/extensions/android/color/ColorExtensionsKt {
+	public static final fun toAndroidColor (Lcom/github/ajalt/colormath/Color;)Landroid/graphics/Color;
+	public static final fun toColormathColor (Landroid/graphics/Color;)Lcom/github/ajalt/colormath/Color;
+	public static final fun toColormathSRGB (Landroid/graphics/Color;)Lcom/github/ajalt/colormath/model/RGB;
+}
+
diff --git a/extensions/colormath-ext-android-colorint/api/colormath-ext-android-colorint.api b/extensions/colormath-ext-android-colorint/api/colormath-ext-android-colorint.api
@@ -0,0 +1,6 @@
+public final class com/github/ajalt/colormath/extensions/android/colorint/ColorIntExtensionsKt {
+	public static final fun fromColorInt (Lcom/github/ajalt/colormath/model/RGB$Companion;I)Lcom/github/ajalt/colormath/model/RGB;
+	public static final fun fromColorInt (Lcom/github/ajalt/colormath/model/RGBInt$Companion;I)I
+	public static final fun toColorInt (Lcom/github/ajalt/colormath/Color;)I
+}
+
diff --git a/extensions/colormath-ext-jetpack-compose/api/android/colormath-ext-jetpack-compose.api b/extensions/colormath-ext-jetpack-compose/api/android/colormath-ext-jetpack-compose.api
@@ -0,0 +1,6 @@
+public final class com/github/ajalt/colormath/extensions/android/composecolor/ComposeColorExtensionsKt {
+	public static final fun toColormathColor-8_81llA (J)Lcom/github/ajalt/colormath/Color;
+	public static final fun toColormathSRGB-8_81llA (J)Lcom/github/ajalt/colormath/model/RGB;
+	public static final fun toComposeColor (Lcom/github/ajalt/colormath/Color;)J
+}
+
diff --git a/extensions/colormath-ext-jetpack-compose/api/jvm/colormath-ext-jetpack-compose.api b/extensions/colormath-ext-jetpack-compose/api/jvm/colormath-ext-jetpack-compose.api
@@ -0,0 +1,6 @@
+public final class com/github/ajalt/colormath/extensions/android/composecolor/ComposeColorExtensionsKt {
+	public static final fun toColormathColor-8_81llA (J)Lcom/github/ajalt/colormath/Color;
+	public static final fun toColormathSRGB-8_81llA (J)Lcom/github/ajalt/colormath/model/RGB;
+	public static final fun toComposeColor (Lcom/github/ajalt/colormath/Color;)J
+}
+
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -16,6 +16,8 @@ robolectric =  "org.robolectric:robolectric:4.10"
 [plugins]
 dokka = "org.jetbrains.dokka:1.9.10"
 publish = "com.vanniktech.maven.publish:0.27.0"
+kotlinBinaryCompatibilityValidator = "org.jetbrains.kotlinx.binary-compatibility-validator:0.14.0"
+
 # used in extensions
 android-library = "com.android.library:7.4.0"