How to upload a kotlin multiplatform project library.

Bagan, Myanmar
@_a_akira
How to publish 
a Kotlin Multiplatform Library

View Slide

About me
@_a_akira AAkira
CyberAgent, Inc.
Akira Aratani
https://aakira.app
"#$%&'()*+,-./012345678
⊿

View Slide

Agenda
• MPPライブラリのパッケージ構成
• MPPライブラリのGradleの設定
• BintrayへのUpload

View Slide

Agenda
• Kotlin/Nativeチュートリアル Android, iOS編 
http://aakira.app/blog/2018/10/kotlin-native
• Kotlin Multiplatform構想 ~今やる理由編~ 
https://aakira.app/blog/2018/12/kotlin-mpp-reason
• Kotlin Multiplatform構想 ~設計編~ 
https://aakira.app/blog/2018/12/kotlin-mpp-architecture
• Kotlin Multiplatform環境でKotlin Serializationと 
Android ExtensionsのParcelize Annotationを使う 
http://aakira.app/blog/2018/12/kotlin-mpp-android-parcelable
• NapierというKotlin Multiplatform用のログライブラリを作った 
https://aakira.app/blog/2019/02/napier

View Slide

Agenda
Timber likeなKotlin mpp用ライブラリ
https://github.com/AAkira/Napier

View Slide

Agenda

View Slide

Kotlin Multiplatform Libraryの 
パッケージ構成
Yangon, Myanmar

View Slide

パッケージ構成 (~Kotlin1.3)
.
├── android
│ ├── src
│ └── build.gradle (apply plugin: 'kotlin-platform-android')
├── common
│ ├── src
│ │ └── main
│ └── build.gradle (apply plugin: 'kotlin-platform-common')
├── ios
│ ├── src
│ │ └── main
│ └── build.gradle (apply plugin: 'org.jetbrains.kotlin.platform.native')
└─── js
├── src
│ └── main
└── build.gradle (apply plugin: 'kotlin-platform-js')

View Slide

パッケージ構成 (~Kotlin1.3)
各ディレクトリ毎にbuild.gradleがある
.
├── android
│ ├── src
│ └── build.gradle (apply plugin: 'kotlin-platform-android')
├── common
│ ├── src
│ │ └── main
│ └── build.gradle (apply plugin: 'kotlin-platform-common')
├── ios
│ ├── src
│ │ └── main
│ └── build.gradle (apply plugin: 'org.jetbrains.kotlin.platform.native')
└─── js
├── src
│ └── main
└── build.gradle (apply plugin: 'kotlin-platform-js')

View Slide

パッケージ構成 (Kotlin1.3~)
.
└── library
├── build.gradle (apply plugin: 'kotlin-multiplatform')
└── src
├── androidMain
├── androidTest
├── commonMain
├── commonTest
├── iosMain
├── iosTest
├── jsMain
├── jsTest
├── jvmMain
└── jvmTest

View Slide

.
└── library
└── src
├── iosMain
├── iosTest
├── jsMain
├── jsTest
├── jvmMain
└── jvmTest
build.gradleは1つのみ

View Slide

パッケージ構成
何よりも信頼出来るJakeの力強い "yes" 
@Kotlinlang slack

View Slide

.
└── library
└── src
├── iosMain
├── iosTest
├── jsMain
├── jsTest
├── jvmMain
└── jvmTest
build.gradleは1つのみが正しい

View Slide

Talat rotfai ratchada, Bangkok, Thailand
Kotlin Multiplatform Libraryの 
Gradle設定

View Slide

Gradle設定
• Common
• Android
• iOS
• JVM
• JS
今回配布するライブラリ
.
├── library
│ ├── android.gradle
│ ├── build.gradle
│ └── src
│ ├── androidMain
│ ├── androidTest
│ ├── commonMain
│ ├── commonTest
│ ├── iosMain
│ ├── iosTest
│ ├── jsMain
│ ├── jsTest
│ ├── jvmMain
│ └── jvmTest
└─── build.gradle

View Slide

Gradle設定
• Common
• Android
• iOS
• JVM
• JS
今回配布するライブラリ
.
├── library
│ ├── android.gradle
│ ├── build.gradle
│ └── src
│ ├── androidMain
│ ├── androidTest
│ ├── commonMain
│ ├── commonTest
│ ├── iosMain
│ ├── iosTest
│ ├── jsMain
│ ├── jsTest
│ ├── jvmMain
│ └── jvmTest
└─── build.gradle
androidは 
「apply plugin: 'com.android.library'」を読み込む
& 
android用のSDK version等の記述をする 
必要があるので分ける

View Slide

Gradle設定
IntelliJ IDEAだとデフォルトで用意されている

View Slide

Gradle設定
apply plugin: 'kotlin-multiplatform'
apply from: 'android.gradle'
apply from: rootProject.file('gradle/publish.gradle')
kotlin {
android()
iosX64('ios')
iosArm32('iosArm32')
js()
jvm()
sourceSets {
commonMain.dependencies { }
commonTest.dependencies { }
androidMain.dependencies { }
androidTest.dependencies { }
iosMain.dependencies { }
iosTest.dependencies { }
iosArm32Main.dependsOn iosMain
iosArm32Test.dependsOn iosTest
jsMain.dependencies { }
jsTest.dependencies { }
jvmMain.dependencies { }
jvmTest.dependencies { }
}
} library/build.gradle

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定
library/build.gradle

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定
android用のgradleは別で定義 
(略) 詳しくはサンプルを見てください

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定
publish用のgradleは別定義(後述)

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定
Kotlin1.3から書き方が変わった

View Slide

kotlin {
targets {
fromPreset(presets.android, 'android')
fromPreset(presets.iosArm64, 'ios')
fromPreset(presets.js, 'js')
fromPreset(presets.jvm, 'jvm')
}
sourceSets {
Gradle設定
~Kotlin1.3

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定

View Slide

js()
jvm()
sourceSets {
androidTest.dependencies { }
iosMain.dependencies { }
iosTest.dependencies { }
jsMain.dependencies { }
jsTest.dependencies { }
jvmMain.dependencies { }
jvmTest.dependencies { }
}
}
Gradle設定
それぞれの依存を定義

View Slide

kotlin {
android()
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定

View Slide

kotlin {
android {
publishLibraryVariants("release")
}
iosX64('ios')
js()
jvm()
sourceSets {
Gradle設定
android libraryは 
release buildを指定する必要がある

View Slide

apply plugin: 'maven-publish'
def pomConfig = {
licenses {
license {
name POM_LICENSE_NAME
url POM_LICENSE_URL
distribution POM_LICENSE_DIST
}
}
developers {
developer {
id POM_DEVELOPER_ID
name POM_DEVELOPER_NAME
organization POM_ORGANIZATION_NAME
organizationUrl POM_ORGANIZATION_URL
}
}
scm {
url SITE_URL
}
}
afterEvaluate {
project.publishing.publications.all {
pom.withXml {
def root = asNode()
root.appendNode('name', project.name)
root.appendNode('description', POM_DESCRIPTION)
root.appendNode('url', SITE_URL)
root.children().last() + pomConfig
}
groupId = BINTRAY_PACKAGE
if (it.name.contains('metadata')) {
artifactId = "${project.name}"
} else {
artifactId = "${project.name}-$name"
}
}
}
Gradle設定 - Maven Publish -
gradle/publish.gradle

View Slide

def pomConfig = {
licenses {
license {
url POM_LICENSE_URL
}
}
developers {
developer {
id POM_DEVELOPER_ID
}
}
scm {
url SITE_URL
}
}

View Slide

def pomConfig = {
licenses {
license {
url POM_LICENSE_URL
}
}
developers {
developer {
id POM_DEVELOPER_ID
}
}
scm {
url SITE_URL
}
}
maven publish pluginをapply

View Slide

def pomConfig = {
licenses {
license {
url POM_LICENSE_URL
}
}
developers {
developer {
id POM_DEVELOPER_ID
}
}
scm {
url SITE_URL
}
}
pomに書き込む用の変数を定義

View Slide

def pomConfig = {
licenses {
license {
name "The Apache Software License, Version 2.0"
url "http://www.apache.org/licenses/LICENSE-2.0.txt"
distribution "repo"
}
}
developers {
developer {
id "aakira"
name "aakira"
organization "aakira"
organizationUrl "https://github.com/aakira"
}
}
scm {
url "https://github.com/aakira/Napier"
}
}
実際の中身

View Slide

def pomConfig = {
licenses {
license {
url POM_LICENSE_URL
}
}
developers {
developer {
id POM_DEVELOPER_ID
}
}
scm {
url SITE_URL
}
}

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
publishで作られる成果物に全てに対して

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
xmlを作成

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
先程指定した変数を追加

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
metadataをrename

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
metadata=commonMainの部分のこと

View Slide

}
}
scm {
url SITE_URL
}
}
afterEvaluate {
pom.withXml {
def root = asNode()
}
} else {
}
}
}
commonMainはsuﬃxなし 
他はsuﬃxに環境名をつける
e.g. napier-android, napier-js

View Slide

pom-default.xml

The Apache Software License, Version 2.0
http://www.apache.org/licenses/LICENSE-2.0.txt
repo

aakira
aakira
aakira
https://github.com/aakira

https://github.com/aakira/Napier

View Slide

• publish
• publishAndroidReleasePublicationToMavenLocal
• publishIosArm32PublicationToMavenLocal
• publishIosArm64PublicationToMavenLocal
• publishIosPublicationToMavenLocal
• publishJsPublicationToMavenLocal
• publishJvmPublicationToMavenLocal
• publishKotlinMultiplatformPublicationToMavenLocal
• publishMetadataPublicationToMavenLocal
• publishToMavenLocal
targetの数だけmaven publishに関するtaskが作られる

View Slide

$ ./gradlew publishToMavenLocal
build
└── publications
├── androidRelease
│ ├── module.json
│ └── pom-default.xml
├── ios
├── iosArm32
├── iosArm64
├── js
├── jvm
├── kotlinMultiplatform
└── metadata
├── module.json
└── pom-default.xml

View Slide

build
└── publications
├── androidRelease
├── ios
├── iosArm32
├── iosArm64
├── js
oMavenLocal

View Slide

├── iosArm32
├── iosArm64
├── js
├── jvm
├── kotlinMultiplatform
└── metadata
├── module.json
└── pom-default.xml
oMavenLocal

View Slide

Gradle設定 - Gradle Publish -
/build.gradle
buildscript {
repositories {
...
}
dependencies {
...
classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4"
...
}
}
https://github.com/bintray/gradle-bintray-plugin

View Slide

apply plugin: 'com.jfrog.bintray'
def getBintrayUserProperty() {
return hasProperty('bintrayUser') ? project.property('bintrayUser') : System.getenv('BINTRAY_USER')
}
def getBintrayApiKeyProperty() {
return hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') : System.getenv('BINTRAY_API_KEY')
}
bintray {
user = getBintrayUserProperty()
key = getBintrayApiKeyProperty()
publish = false
pkg {
repo = BINTRAY_REPOSITORY
name = BINTRAY_NAME
userOrg = GROUP
licenses = ['Apache-2.0']
vcsUrl = VCS_URL
websiteUrl = SITE_URL
issueTrackerUrl = ISSUE_URL
version {
name = rootProject.ext.LIBRARY_VERSION_NAME
vcsTag = rootProject.ext.LIBRARY_VERSION_NAME
released = new Date()
}
}
}
bintrayUpload.doFirst {
publications = publishing.publications.collect {
it.name
}.findAll {
it != "kotlinMultiplatform"
}
}
bintrayUpload.dependsOn publishToMavenLocal

View Slide

}
}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL

View Slide

}
}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
bintrayのpluginをapply

View Slide

}
}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
bintrayのuser名, API Keyを読み込む
gitに追加されないlocalの 
~/.gradle/gradle.properties
に書いておくと良い

View Slide

return hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') :
System.getenv('BINTRAY_API_KEY')
}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
version {
}
}
}

View Slide

}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
version {
}
}
}
keyをセット

View Slide

}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
version {
}
}
}
upload後すぐに公開しない

View Slide

}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
version {
}
}
}

View Slide

}
bintray {
publish = false
pkg {
repo = 'maven'
name = 'napier'
userOrg = 'aakira'
vcsUrl = 'https://github.com/aakira/Napier.git'
websiteUrl = 'https://github.com/aakira/Napier'
issueTrackerUrl = 'https://github.com/aakira/Napier/issues'
version {
name = '0.0.1'
vcsTag = '0.0.1'
}
}
}

View Slide

}
bintray {
publish = false
pkg {
name = BINTRAY_NAME
userOrg = GROUP
vcsUrl = VCS_URL
version {
}
}
}

View Slide

version {
}
}
}
it.name
}.findAll {
}
}
bintrayにuploadするpublicationsを指定

View Slide

version {
}
}
}
it.name
}.findAll {
}
}
[project name]-kotlinMultiplatform 
というディレクトリがアップロードされてしまうので除外

View Slide

version {
}
}
}
it.name
}.findAll {
}
}
bintrayUpload taskにpublishToMavenLocalを依存させる

View Slide

Wat Arun, Bangkok, Thailand
BintrayへのUpload

View Slide

BintrayへのUpload

View Slide

BintrayへのUpload
今回はMavenを選択
 
publish.gradleのBINTRAY_REPOSITORYと一致

View Slide

BintrayへのUpload

View Slide

BintrayへのUpload
UI変わった

View Slide

BintrayへのUpload
BINTRAY_NAME
ISSUE_URL
VCS_URL
SITE_URL

View Slide

BintrayへのUpload
$ ./gradlew clean
$ ./gradlew bintrayUpload

View Slide

BintrayへのUpload

View Slide

BintrayへのUpload
Publish allを選択すると公開される

View Slide

BintrayへのUpload
/build.gradle
buildscript {
repositories {
...
maven { url "http://dl.bintray.com/[bintray repository]/[bintray name]" }
...
}
}

View Slide

BintrayへのUpload
/build.gradle
buildscript {
repositories {
...
maven { url "http://dl.bintray.com/[bintray repository]/[bintray name]" }
...
}
}
ライブラリ毎にmavenのrepositoryを書かないといけない

View Slide

BintrayへのUpload
右上のActionから選択

View Slide

BintrayへのUpload
それっぽい説明をちゃんと書く

View Slide

BintrayへのUpload
/build.gradle
buildscript {
repositories {
jcenter()
}
}

View Slide

Wat Paknam, Bangkok, Thailand
Summary

View Slide

Summary
• Kotlin1.3からはgradleを1つにした構成にしましょう
• metadataの成果物はcommonのこと
• androidの配布はreleaseを明示的に書く必要あり
• ライブラリをローカルで参照する方法はサンプルを(時間の都合)
• Napierのpublish.gradleコピペすればすぐ上げられる 
(先人の犠牲を無駄にするな...)

View Slide

Have a nice Kotlin
@_a_akira
Bagan, Myanmar

View Slide

How to upload a kotlin multiplatform project library.

How to upload a kotlin multiplatform project library.

AAkira

More Decks by AAkira

Other Decks in Technology

Featured

Transcript