Use abiValidation to prevent breaking changes in extension library

.github/workflows/pull_request.yml

@@ -26,6 +26,11 @@ jobs:
         cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
         cache-read-only: false
 
+    - name: Ensure binary compatibility
+      # This is to ensure that your code is backwards compatible.
+      # If this fails you need to add a @Prerelease annotation to new code.
+      run: ./gradlew library:checkKotlinAbi
+
     - name: Run Gradle
       run: ./gradlew assemblePrereleaseDebug lint
 

library/README.md

@@ -0,0 +1,15 @@
+## CloudStream extension library
+
+This is the official API surface for all CloudStream plugins.
+
+To ensure that all plugins work on both the stable release and pre-release we must have
+binary compatibility on all changes. All new changes must be marked with `@Prerelease` to
+prevent accidental usage among extension developers.
+
+We use Kotlin binary compatibility validation using:
+
+``./gradlew checkKotlinAbi``
+
+If you for some reason must update the binary compatibility then manually edit `api/jvm/library.api` or use:
+
+``./gradlew updateKotlinAbi``