Add Binary Compatability Validator

ajalt · Nov 19, 2023 · aeba05e · aeba05e
1 parent 934f2e5
commit aeba05e
Show file tree

Hide file tree

Showing 5 changed files with 1,182 additions and 3 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -21,7 +21,7 @@ jobs:
           - os: windows-latest
             NATIVE_TEST_TASK: :mordant:mingwX64Test
           - os: ubuntu-latest
-            NATIVE_TEST_TASK: :mordant:linuxX64Test
+            NATIVE_TEST_TASK: :mordant:linuxX64Test apiCheck
     runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,7 +17,7 @@ jobs:
           - os: windows-latest
             NATIVE_TEST_TASK: :mordant:mingwX64Test
           - os: ubuntu-latest
-            NATIVE_TEST_TASK: :mordant:linuxX64Test
+            NATIVE_TEST_TASK: :mordant:linuxX64Test :test:proguard:r8jar apiCheck
     runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v3
@@ -42,7 +42,6 @@ jobs:
             :mordant:jvmTest
             :mordant:jsTest
             :test:graalvm:nativeTest
-            :test:proguard:r8jar
             ${{matrix.NATIVE_TEST_TASK}}
             --stacktrace
       - name: Run R8 Jar

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -7,6 +7,7 @@ plugins {
     kotlin("multiplatform").version(libs.versions.kotlin).apply(false)
     alias(libs.plugins.dokka).apply(false)
     alias(libs.plugins.publish).apply(false)
+    alias(libs.plugins.kotlinApiDump)
 }
 
 val VERSION_NAME: String by project
@@ -64,3 +65,9 @@ subprojects {
         }
     }
 }
+
+apiValidation {
+    // https://github.com/Kotlin/binary-compatibility-validator/issues/3
+    project("samples").subprojects.mapTo(ignoredProjects) { it.name }
+    project("test").subprojects.mapTo(ignoredProjects) { it.name }
+}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -18,3 +18,4 @@ r8 = "com.android.tools:r8:8.1.56"
 dokka = "org.jetbrains.dokka:1.9.10"
 publish = "com.vanniktech.maven.publish:0.25.3"
 graalvm-nativeimage = "org.graalvm.buildtools.native:0.9.27"
+kotlinApiDump = "org.jetbrains.kotlinx.binary-compatibility-validator:0.13.2"