From 9b8396074cad788f023cc959a28e9895f1e03069 Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Wed, 1 Oct 2025 12:53:14 +0200 Subject: [PATCH] Keep apiDump and apiCheck for backward compatibility --- docs/src/content/docs/index.md | 12 ++++-------- .../main/kotlin/com/gradleup/librarian/gradle/bcv.kt | 9 +++++++++ 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/src/content/docs/index.md b/docs/src/content/docs/index.md index 25e0323..35ab819 100644 --- a/docs/src/content/docs/index.md +++ b/docs/src/content/docs/index.md @@ -12,20 +12,16 @@ If you have questions, please ask in the `#gradleup` channel in the [Gradle comm Librarian: +* creates default publications based on applied plugins * publishes your KMP/Android/JVM libraries to: * Maven Central releases * Maven Central snapshots * [Google Cloud Storage](https://cloud.google.com/storage?hl=en) -* generates versioned KDoc using [Dokka](https://github.com/Kotlin/dokka) -* automates your workflows using GitHub actions: - * pull requests - * documentation - * SNAPSHOTs - * releases +* publishes versioned KDoc using [Dokka](https://github.com/Kotlin/dokka) * generates a Kotlin property holding your library version -* monitors your binary compatibility using Kotlin Binary Compatibility validator +* configures Binary Compatibility validator * configures Java and Kotlin compatibility -* ensure your libs can be consumed with maven +* configures maven compatibility for your lib * and more! diff --git a/librarian-gradle-plugin/src/main/kotlin/com/gradleup/librarian/gradle/bcv.kt b/librarian-gradle-plugin/src/main/kotlin/com/gradleup/librarian/gradle/bcv.kt index e04ac45..85fadd6 100644 --- a/librarian-gradle-plugin/src/main/kotlin/com/gradleup/librarian/gradle/bcv.kt +++ b/librarian-gradle-plugin/src/main/kotlin/com/gradleup/librarian/gradle/bcv.kt @@ -23,6 +23,15 @@ internal fun Project.configureBcv(properties: Properties?) { tasks.named("build") { it.dependsOn("checkLegacyAbi") } + /** + * Compatibility tasks to not break the brain muscle + */ + tasks.register("apiDump") { + it.dependsOn("updateLegacyAbi") + } + tasks.register("apiCheck") { + it.dependsOn("updateLegacyAbi") + } } else { if (properties != null && properties.get("bcv.warn") != "false") { println("Librarian: BCV is only configured by default if using KGP 2.2+ (currently detected is '$librarianKotlinPluginVersion'). Set bcv.warn=false in your librarian.root.properties file to remove this warning.")