Настройка публикации мультиплатформенной библиотеки

Публикация в локальный репозиторий Maven

Вы можете опубликовать мультиплатформенную библиотеку в локальный репозиторий Maven с помощью плагина Gradle maven-publish:

1. В файле shared/build.gradle.kts добавьте плагин Gradle maven-publish.

2. Укажите группу и версию библиотеки, а также репозитории, в которые она должна быть опубликована:

   plugins {
       // ...
       id("maven-publish")
   }
   
   group = "com.example"
   version = "1.0"
   
   publishing {
       repositories {
           maven {
               //...
           }
       }
   }
   

При использовании с maven-publish плагин Kotlin автоматически создает публикации для каждой цели, которую можно собрать на текущем хосте, за исключением целевой платформы Android, для которой требуется дополнительный шаг настройки публикации.

Структура публикаций

Публикации библиотеки Kotlin Multiplatform включают несколько публикаций Maven, каждая из которых соответствует определенной цели. Кроме того, публикуется сводная публикация корневого уровня, kotlinMultiplatform, представляющая библиотеку целиком.

При добавлении в качестве зависимости в общий набор исходного кода корневая публикация автоматически разрешается в соответствующие артефакты для конкретной платформы.

// projectName = "lib"
group = "test"
version = "1.0"

kotlin {
    jvm()
    iosArm64()
}

./gradlew publishAllPublicationsToGithubPackagesRepository

./gradlew publishToMavenLocal

./gradlew publishKotlinMultiplatformPublicationToMavenLocal

./gradlew publish<TargetName>PublicationToMavenLocal

Требования к хосту

Kotlin/Native поддерживает кросс-компиляцию, позволяя любому хосту создавать необходимые артефакты .klib. Однако следует учитывать некоторые ограничения.

Публикация библиотеки Android

Для публикации библиотеки Android необходимо выполнить дополнительную настройку. По умолчанию артефакты библиотеки Android не публикуются.

Чтобы публиковать артефакты, добавьте блок androidLibrary {} в файл shared/build.gradle.kts и настройте публикацию с помощью DSL KMP. Например:

kotlin {
    androidLibrary {
        namespace = "org.example.library"
        compileSdk = libs.versions.android.compileSdk.get().toInt()
        minSdk = libs.versions.android.minSdk.get().toInt()

        // Enables Java compilation support.
        // This improves build times when Java compilation is not needed
        withJava()

        compilations.configureEach {
            compilerOptions.configure {
                jvmTarget.set(
                    JvmTarget.JVM_11
                )
            }
        }
    }
}

Обратите внимание, что плагин Android Gradle Library не поддерживает продуктовые варианты и варианты сборки, что упрощает конфигурацию. Поэтому необходимо явно включить создание тестовых наборов исходного кода и конфигураций. Например:

kotlin {
    androidLibrary {
        // ...

        // Opt in to enable and configure host-side (unit) tests
        withHostTestBuilder {}.configure {}

        // Opt in to enable device tests, specifying the source set name
        withDeviceTestBuilder {
            sourceSetTreeName = "test"
        }

        // ...
    }
}

Ранее для запуска тестов, например с помощью действия GitHub, требовалось отдельно указывать варианты debug и release:

- target: testDebugUnitTest
  os: ubuntu-latest
- target: testReleaseUnitTest
  os: ubuntu-latest

С плагином Android Gradle Library нужно указать только общую цель с именем набора исходного кода:

- target: testAndroidHostTest
  os: ubuntu-latest

Отключение публикации исходного кода

По умолчанию плагин Kotlin Multiplatform для Gradle публикует исходный код для всех указанных целей. Однако вы можете настроить публикацию исходного кода и отключить ее с помощью API withSourcesJar() в файле shared/build.gradle.kts:

• Чтобы отключить публикацию исходного кода для всех целей:

  kotlin {
      withSourcesJar(publish = false)
  
      jvm()
      linuxX64()
  }
  

• Чтобы отключить публикацию исходного кода только для указанной цели:

  kotlin {
       // Disable sources publication only for JVM:
      jvm {
          withSourcesJar(publish = false)
      }
      linuxX64()
  }
  

• Чтобы отключить публикацию исходного кода для всех целей, кроме указанной:

  kotlin {
      // Disable sources publication for all targets except for JVM:
      withSourcesJar(publish = false)
  
      jvm {
          withSourcesJar(publish = true)
      }
      linuxX64()
  }
  

Продвижение библиотеки

Ваша библиотека может быть представлена в каталоге мультиплатформенных библиотек JetBrains. Он помогает находить библиотеки Kotlin Multiplatform с учетом поддерживаемых ими целевых платформ.

Библиотеки, соответствующие критериям, добавляются автоматически. Подробнее о том, как обеспечить появление вашей библиотеки в каталоге, см. в разделе FAQ.

Что дальше

• Узнайте, как опубликовать библиотеку Kotlin Multiplatform в репозитории Maven Central

• Ознакомьтесь с рекомендациями для авторов библиотек: лучшие практики и советы по разработке библиотек для Kotlin Multiplatform