Improve public api tracking

README.md

@@ -58,6 +58,15 @@ Setup instruction: Follow the steps from the SETUP.md file.
     Provide detailed documentation that explains how to use the project effectively.
 -->
 
+<!-- 
+    To keep track of public API (and breaking changes), you can use the following plugin:
+    https://github.com/Kotlin/binary-compatibility-validator
+    Plugin is already integrated in the project, you can run it with (read more in the plugin's README):
+    ./gradlew apiDump
+    ./gradlew apiCheck
+
+-->
+
 ## // OPTIONAL: Configuration //
 
 <!--

build.gradle.kts

@@ -1,5 +1,10 @@
 plugins {
     alias(libs.plugins.detekt.plugin)
+    alias(libs.plugins.kotlin.binary.compatibility.validator)
+}
+
+apiValidation {
+    ignoredProjects.addAll(listOf("sample"))
 }
 
 buildscript {

gradle/libs.versions.toml

@@ -4,9 +4,13 @@ androidGradlePlugin = "8.6.0"
 detekt = "1.23.6"
 dokka = "1.9.10"
 kotlin = "2.0.20"
+jetbrainsKotlinJvm = "2.0.20"
+binaryCompatibilityValidator = "0.17.0"
 
 [plugins]
 detekt-plugin = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt"}
+kotlin-binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binaryCompatibilityValidator" }
+jetbrains-kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "jetbrainsKotlinJvm" }
 
 [libraries]
 androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" }

libModule1/build.gradle.kts

@@ -1,6 +1,8 @@
+import org.jetbrains.kotlin.gradle.dsl.kotlinExtension
+
 plugins {
     id("java-library")
-    id("kotlin")
+    id(libs.plugins.jetbrains.kotlin.jvm.get().pluginId)
 }
 
 apply {
@@ -16,6 +18,8 @@ val sonatype: Map<String, Any> by project
 java {
     sourceCompatibility = JavaVersion.VERSION_17
     targetCompatibility = JavaVersion.VERSION_17
+    kotlinExtension.explicitApi()
+    kotlin.jvmToolchain(17)
 }
 
 // specify per module - mostly needed due to different artifactIds, names, descriptions

libModule1/src/main/java/com/infinum/libname/libModule1/MyClass.kt

@@ -1,3 +1,3 @@
 package com.infinum.libname.libModule1
 
-class MyClass
+private class MyClass

libModule2/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.ExplicitApiMode
+
 plugins {
     id("com.android.library")
     id("org.jetbrains.kotlin.android")
@@ -37,6 +39,9 @@ android {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
     }
+    kotlin{
+        explicitApi()
+    }
     kotlinOptions {
         jvmTarget = "17"
     }

libModule2/src/main/java/com/infinum/libname/libModule2/MyClass.kt

@@ -1,3 +1,3 @@
 package com.infinum.libname.libModule2
 
-class MyClass
+private class MyClass

settings.gradle.kts

@@ -1,3 +1,7 @@
+plugins {
+    id("org.gradle.toolchains.foojay-resolver-convention") version("0.8.0")
+}
+
 include(":libModule1")
 include(":libModule2")
 include(":sample")