Skip to content

Commit a809589

Browse files
committed
build: Add dokka config
1 parent 6ef7cf0 commit a809589

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

build.gradle.kts

+21
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,14 @@ buildscript {
2626
classpath(libs.gradlePlugin.kotlinxAtomicfu)
2727
classpath(libs.gradlePlugin.kotlinxCover)
2828
classpath(libs.gradlePlugin.mavenPublish)
29+
// classpath(libs.gradlePlugin.dokka)
2930
}
3031
}
3132

33+
plugins {
34+
alias(libs.plugins.dokka)
35+
}
36+
3237
allprojects {
3338
repositories {
3439
// maven { setUrl("https://maven.aliyun.com/repository/public") } // central、jcenter
@@ -51,6 +56,7 @@ allprojects {
5156
jvmTargetConfig()
5257
composeConfig()
5358
publishConfig()
59+
dokkaConfig()
5460
applyOkioJsTestWorkaround()
5561
androidTestConfig()
5662
}
@@ -132,11 +138,26 @@ fun Project.publishConfig() {
132138
&& hasProperty("signing.secretKeyRingFile") // configured in the ~/.gradle/gradle.properties file
133139
) {
134140
signAllPublications()
141+
} else if (
142+
System.getenv("ORG_GRADLE_PROJECT_signingInMemoryKey").orEmpty()
143+
.isNotEmpty() // configured in the github workflow env
144+
&& System.getenv("ORG_GRADLE_PROJECT_signingInMemoryKeyPassword").orEmpty()
145+
.isNotEmpty() // configured in the github workflow env
146+
) {
147+
signAllPublications()
135148
}
136149
}
137150
}
138151
}
139152

153+
fun Project.dokkaConfig() {
154+
if (
155+
hasProperty("POM_ARTIFACT_ID") // configured in the module/gradle.properties file
156+
) {
157+
apply { plugin("org.jetbrains.dokka") }
158+
}
159+
}
160+
140161
// https://github.com/square/okio/issues/1163
141162
fun Project.applyOkioJsTestWorkaround() {
142163
if (":sample" in displayName) {

libs.versions.toml

+7-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ appdirs = "1.2.2"
2121

2222
cashapp-paging = "3.3.0-alpha02-0.5.1"
2323

24+
dokka = "1.9.20"
25+
2426
coil3 = "3.0.4"
2527
coil2 = "2.7.0"
2628

@@ -74,6 +76,7 @@ gradlePlugin-kotlinSerialization = { module = "org.jetbrains.kotlin:kotlin-seria
7476
gradlePlugin-kotlinxAtomicfu = { module = "org.jetbrains.kotlinx:atomicfu-gradle-plugin", version.ref = "kotlinx-atomicfu" }
7577
gradlePlugin-kotlinxCover = { module = "org.jetbrains.kotlinx:kover-gradle-plugin", version.ref = "kotlinx-cover" }
7678
gradlePlugin-mavenPublish = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "mavenpublish" }
79+
gradlePlugin-dokka = { module = "org.jetbrains.dokka:org.jetbrains.dokka.gradle.plugin", version.ref = "dokka" }
7780

7881
androidx-activity-compose = { module = "androidx.activity:activity-compose", version.ref = "androidx-activity" }
7982
androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "androidx-appcompat" }
@@ -195,4 +198,7 @@ voyager-transitions = { module = "cafe.adriel.voyager:voyager-transitions", vers
195198
#voyager-koin = { module = "cafe.adriel.voyager:voyager-koin", version.ref = "voyager" }
196199
#voyager-hilt = { module = "cafe.adriel.voyager:voyager-hilt", version.ref = "voyager" }
197200
#voyager-kodein = { module = "cafe.adriel.voyager:voyager-kodein", version.ref = "voyager" }
198-
#voyager-rxjava = { module = "cafe.adriel.voyager:voyager-rxjava", version.ref = "voyager" }
201+
#voyager-rxjava = { module = "cafe.adriel.voyager:voyager-rxjava", version.ref = "voyager" }
202+
203+
[plugins]
204+
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }

0 commit comments

Comments
 (0)