skills.rest
trancee
tranceeCOMMUNITY
Explore all skills by this author →
GitHub

kotlin-binary-compatibility-validator

Validate Kotlin/JVM and KLib public binary API compatibility.

Updated Jul 20, 2026
Search Tags:#sdk#kotlin#gradle#api-validation#abi#binary-compatibility
One-click install
npx skills add https://github.com/trancee/MeshLink-template --skill kotlin-binary-compatibility-validator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: kotlin-binary-compatibility-validator
Source: https://github.com/trancee/MeshLink-template/tree/main/.agents/skills/kotlin-binary-compatibility-validator
Command: npx skills add https://github.com/trancee/MeshLink-template --skill kotlin-binary-compatibility-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill prevents accidental binary-incompatible changes in Kotlin/JVM and KLib libraries by automating the generation and validation of public API signatures.

Core Features & Use Cases

  • API Dumping: Automatically generates human-readable files representing the public binary surface of your library.
  • Compatibility Checking: Integrates with the build process to fail CI if a change breaks binary compatibility.
  • Use Case: When developing a shared SDK, use this to ensure that refactoring internal code does not inadvertently change the public method signatures that downstream consumers rely on.

Quick Start

Run the apiDump task to generate the current public API signatures for your project.

Frequently Asked Questions about kotlin-binary-compatibility-validator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prevent breaking changes in my Kotlin library API?▼

You can prevent breaking changes in a Kotlin library API by validating the public binary API of Kotlin/JVM and KLib libraries. This involves generating human-readable API signature dumps and verifying them during your build process to catch accidental binary-incompatible changes.

What is binary compatibility validation for Kotlin SDKs?▼

Binary compatibility validation for Kotlin SDKs tracks ABI evolution across library versions. It ensures that refactoring internal code does not inadvertently change the public method signatures that downstream consumers rely on, maintaining a stable public interface.

How do I dump public API signatures for a multi-target Kotlin project?▼

You can dump public API signatures for a multi-target Kotlin project by running the apiDump task. This automatically generates human-readable files representing the public binary surface of your Kotlin/JVM and KLib libraries for tracking.

Does Gradle support automated API validation for Kotlin KLib libraries?▼

Yes, Gradle supports automated API validation for Kotlin KLib libraries. This skill integrates compatibility checking directly into the Gradle build process to fail CI if a change breaks binary compatibility.

Why does my Kotlin library build fail after refactoring internal code?▼

Your Kotlin library build may fail because the binary compatibility validator detected changes to your public API surface. This build-time verification ensures that refactoring does not inadvertently alter the public method signatures that downstream consumers rely on.

Related Skills

Explore More Software Engineering Skills→
diegoliriodiegolirio

sec-multi-monorepo-kotlin-scaffold

Scaffold Kotlin multi-module monorepos with API and core modules using Gradle Kotlin DSL.

Community
Intermediate
ray-manalotoray-manaloto
1

mise-lockfile

Generate and manage mise lockfiles to pin tool versions and provenance.

Official
Advanced
new-silvermoonnew-silvermoon
915

android-gradle-logic

Centralize Android Gradle build logic with Kotlin DSL convention plugins.

Community
Advanced
Chang-Shih-YungChang-Shih-Yung

health

Aggregate type checker, linter, and test results into a 0-10 composite score.

Community
Advanced