Skip to content

Keep apiDump and apiCheck for backward compatibility #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martinbonnin merged 1 commit into from
Oct 1, 2025
Merged

Keep apiDump and apiCheck for backward compatibility #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/src/content/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!


Expand Down
9 changes: 9 additions & 0 deletions librarian-gradle-plugin/src/main/kotlin/com/gradleup/librarian/gradle/bcv.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.")
Expand Down