Skip to content

Commit a02c087

Browse files
committed
ci: removed always failing 'Build and Publish Docs' workflow
It is broken for almost a year now and nobody uses it anyway. With modern IDEs there is not much need for a JavaDoc like API reference documentation.
1 parent 0832f59 commit a02c087

File tree

3 files changed

+0
-74
lines changed

3 files changed

+0
-74
lines changed

.github/workflows/docs.yaml

Lines changed: 0 additions & 35 deletions
This file was deleted.

build.gradle.kts

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,12 @@ import com.github.gradle.node.NodeExtension
22
import com.github.gradle.node.NodePlugin
33
import io.gitlab.arturbosch.detekt.Detekt
44
import org.gradle.kotlin.dsl.withType
5-
import org.jetbrains.dokka.base.DokkaBase
6-
import org.jetbrains.dokka.base.DokkaBaseConfiguration
7-
import org.jetbrains.dokka.gradle.DokkaTaskPartial
8-
9-
buildscript {
10-
dependencies {
11-
classpath(libs.dokka.base)
12-
}
13-
}
145

156
plugins {
167
`maven-publish`
178
`version-catalog`
189
alias(libs.plugins.kotlin.serialization) apply false
1910
alias(libs.plugins.gitVersion)
20-
alias(libs.plugins.dokka)
2111
alias(libs.plugins.node) apply false
2212
alias(libs.plugins.detekt)
2313
alias(libs.plugins.kotlinx.kover)
@@ -56,20 +46,13 @@ val parentProject = project
5646
subprojects {
5747
val subproject = this
5848
apply(plugin = "maven-publish")
59-
apply(plugin = "org.jetbrains.dokka")
6049
if (subproject.name !in setOf("model-server-openapi")) {
6150
apply(plugin = "org.jetbrains.kotlinx.kover")
6251
}
6352

6453
version = rootProject.version
6554
group = rootProject.group
6655

67-
tasks.withType<DokkaTaskPartial>().configureEach {
68-
pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
69-
footerMessage = dokkaFooterMessage
70-
}
71-
}
72-
7356
subproject.plugins.withType<NodePlugin> {
7457
subproject.extensions.configure<NodeExtension> {
7558
version.set(libs.versions.node)
@@ -143,25 +126,6 @@ tasks.withType<org.jetbrains.kotlin.gradle.targets.js.npm.tasks.KotlinNpmInstall
143126
dependsOn(":ts-model-api:npm_run_build")
144127
}
145128

146-
tasks.dokkaHtmlMultiModule {
147-
val docsDir = project.layout.buildDirectory.dir("dokka").get().asFile
148-
outputDirectory.set(docsDir)
149-
pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
150-
customAssets += file(projectDir.resolve("dokka/logo-dark.svg"))
151-
customAssets += file(projectDir.resolve("dokka/logo-icon.svg"))
152-
customStyleSheets += file(projectDir.resolve("dokka/logo-styles.css"))
153-
footerMessage = dokkaFooterMessage
154-
}
155-
}
156-
157-
val dokkaFooterMessage = """
158-
<span>
159-
<p>For more information visit <a href="https://modelix.org">modelix.org</a>, for further documentation visit <a href="https://docs.modelix.org">docs.modelix.org</a>.</p>
160-
<p>Copyright ${"\u00A9"} 2021-present by the <a href="https://modelix.org">modelix open source project</a> and the individual contributors. All Rights reserved.</p>
161-
<p>Except where otherwise noted, <a href="https://api.modelix.org">api.modelix.org</a>, modelix, and the modelix framework, are licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache-2.0 license</a>.</p>
162-
</span>
163-
""".trimIndent()
164-
165129
catalog {
166130
versionCatalog {
167131
from(files("gradle/libs.versions.toml"))

gradle/libs.versions.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
1212
kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
1313
gitVersion = { id = "com.palantir.git-version", version = "3.3.0" }
1414
modelix-mps-buildtools = { id = "org.modelix.mps.build-tools", version.ref = "modelixBuildtools" }
15-
dokka = {id = "org.jetbrains.dokka", version.ref = "dokka"}
1615
node = {id = "com.github.node-gradle.node", version = "7.1.0"}
1716
detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
1817
npm-publish = { id = "dev.petuska.npm.publish", version = "3.5.3" }
@@ -36,7 +35,6 @@ node="22.16.0"
3635
modelixBuildtools="1.9.0"
3736
openapi = "7.13.0"
3837
micrometer = "1.15.1"
39-
dokka = "2.0.0"
4038
detekt = "1.23.8"
4139
xmlunit = "2.10.3"
4240
kotest = "5.9.1"
@@ -130,7 +128,6 @@ apache-cxf-sse = { group = "org.apache.cxf", name = "cxf-rt-rs-sse", version.ref
130128
apache-cxf-client = { group = "org.apache.cxf", name = "cxf-rt-rs-client", version.ref = "apacheCxf" }
131129

132130
semver = { group = "org.semver", name = "api", version = "0.9.33"}
133-
dokka-base = { group = "org.jetbrains.dokka", name = "dokka-base", version.ref="dokka"}
134131

135132
modelix-buildtools-gradle = { group = "org.modelix.mps", name = "build-tools-gradle", version.ref = "modelixBuildtools"}
136133
modelix-buildtools-lib = { group = "org.modelix.mps", name = "build-tools-lib", version.ref = "modelixBuildtools"}

0 commit comments

Comments
 (0)