Merge pull request #3689 from JetBrains/ktl-1139-metadata-jvm-api-refs

KTL-1139 Set up publishing of kotlinx-metadata-jvm documentation on kotlinlang.org
JetBrains · Jul 21, 2023 · ea0bcef · ea0bcef
2 parents ed29b7c + 97ffce0
commit ea0bcef
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 16 deletions.
diff --git a/.teamcity/builds/apiReferences/kotlinx/datetime/KotlinxDatetimeBuildApiReference.kt b/.teamcity/builds/apiReferences/kotlinx/datetime/KotlinxDatetimeBuildApiReference.kt
@@ -3,7 +3,7 @@ package builds.apiReferences.kotlinx.datetime
 import BuildParams.KOTLINX_DATETIME_RELEASE_TAG
 import builds.apiReferences.dependsOnDokkaTemplate
 import builds.apiReferences.templates.BuildApiReference
-import builds.apiReferences.templates.scriptDokkaVersionSync
+import builds.apiReferences.templates.buildDokkaHTML
 import builds.apiReferences.templates.scriptDropSnapshot
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -16,7 +16,6 @@ object KotlinxDatetimeBuildApiReference : BuildType({
 
     params {
         param("release.tag", KOTLINX_DATETIME_RELEASE_TAG)
-        param("DOKKA_TEMPLATE_TASK", ":kotlinx-datetime:dokkaHtml")
     }
 
     vcs {
@@ -34,5 +33,8 @@ object KotlinxDatetimeBuildApiReference : BuildType({
             sed -i -E "s/versionSuffix=SNAPSHOT//gi" ./gradle.properties
             """.trimIndent()
         }
+        buildDokkaHTML {
+            tasks = ":kotlinx-datetime:dokkaHtml"
+        }
     }
 })
diff --git a/.teamcity/builds/apiReferences/kotlinx/metadataJvm/KotlinxMetadataJvmBuildApiReference.kt b/.teamcity/builds/apiReferences/kotlinx/metadataJvm/KotlinxMetadataJvmBuildApiReference.kt
@@ -2,10 +2,9 @@ package builds.apiReferences.kotlinx.metadataJvm
 
 import BuildParams.KOTLINX_METADATA_JVM_RELEASE_TAG
 import builds.apiReferences.dependsOnDokkaTemplate
-import builds.apiReferences.templates.BuildApiReference
-import builds.apiReferences.templates.scriptDropSnapshot
+import builds.apiReferences.templates.*
 import jetbrains.buildServer.configs.kotlin.BuildType
-import jetbrains.buildServer.configs.kotlin.triggers.vcs
+import jetbrains.buildServer.configs.kotlin.buildSteps.script
 
 object KotlinxMetadataJvmBuildApiReference : BuildType({
     name = "kotlinx-metadata-jvm API reference"
@@ -16,11 +15,10 @@ object KotlinxMetadataJvmBuildApiReference : BuildType({
 
     params {
         param("release.tag", KOTLINX_METADATA_JVM_RELEASE_TAG)
-        param("DOKKA_TEMPLATE_TASK", ":kotlinx-metadata-jvm:dokkaHtml -PkotlinxMetadataDeployVersion=${KOTLINX_METADATA_JVM_RELEASE_TAG}")
     }
 
     triggers {
-        vcs {
+        vcsDefaultTrigger {
             enabled = false
         }
     }
@@ -33,6 +31,48 @@ object KotlinxMetadataJvmBuildApiReference : BuildType({
         scriptDropSnapshot {
             enabled = false
         }
+        buildDokkaHTML {
+            enabled = false
+        }
+        scriptDokkaVersionSync {
+            scriptContent = """
+                #!/bin/bash
+                set -e
+                set +x
+                set -o pipefail
+                set -u
+
+                # update Dokka version
+                sed -i -E "s/dokka ?= ?\"[0-9\.]+\"/dokka = \"%DOKKA_TEMPLATES_VERSION%\"/gi" ./gradle/libs.versions.toml
+                
+                # Define the replacement string
+                replacement="maven(url = \"$DOKKA_SPACE_REPO\")\nmavenCentral"
+                
+                # List of kts files to apply the command on
+                files=(
+                  "./build.gradle.kts"
+                  "./repo/gradle-settings-conventions/settings.gradle.kts"
+                  "./repo/gradle-build-conventions/buildsrc-compat/build.gradle.kts"
+                )
+                
+                # Loop through the files and apply the sed command
+                for file in "${'$'}{files[@]}"; do
+                    sed -i -E "s|mavenCentral|${'$'}replacement|" "${'$'}file"
+                done
+                
+                # modify Groovy file
+                sed -i -E "s|mavenCentral|maven \{ url \"$DOKKA_SPACE_REPO\" \}\nmavenCentral|" ./settings.gradle
+                
+                # add Dokka dev artifacts to the list of trusted ones
+                sed -i -E "s|<trusted-artifacts>|<trusted-artifacts>\n<trust group=\"org.jetbrains.dokka\" />\n|" ./gradle/verification-metadata.xml
+            """.trimIndent()
+        }
+        script {
+            name = "build api reference"
+            scriptContent = """
+                ./gradlew :kotlinx-metadata-jvm:dokkaHtml -PkotlinxMetadataDeployVersion=${KOTLINX_METADATA_JVM_RELEASE_TAG}
+            """.trimIndent()
+        }
     }
 
     dependencies {

diff --git a/.teamcity/builds/apiReferences/templates/BuildApiReference.kt b/.teamcity/builds/apiReferences/templates/BuildApiReference.kt
@@ -3,8 +3,11 @@ package builds.apiReferences.templates
 import BuildParams.DOKKA_TEMPLATES_VERSION
 import jetbrains.buildServer.configs.kotlin.BuildSteps
 import jetbrains.buildServer.configs.kotlin.Template
+import jetbrains.buildServer.configs.kotlin.Trigger
+import jetbrains.buildServer.configs.kotlin.Triggers
+import jetbrains.buildServer.configs.kotlin.buildSteps.GradleBuildStep
 import jetbrains.buildServer.configs.kotlin.buildSteps.ScriptBuildStep
-import jetbrains.buildServer.configs.kotlin.buildSteps.gradle
+import jetbrains.buildServer.configs.kotlin.triggers.VcsTrigger
 import jetbrains.buildServer.configs.kotlin.triggers.vcs
 
 fun BuildSteps.scriptDropSnapshot(block: ScriptBuildStep.() -> Unit) = step(
@@ -36,6 +39,21 @@ fun BuildSteps.scriptDokkaVersionSync(block: ScriptBuildStep.() -> Unit) = step(
     }.apply(block),
 )
 
+fun BuildSteps.buildDokkaHTML(block: GradleBuildStep.() -> Unit) = step(
+    GradleBuildStep {
+        id = "step-build-dokka-html-id"
+        name = "Build dokka html"
+        tasks = "dokkaHtmlMultiModule"
+    }.apply(block),
+)
+
+fun Triggers.vcsDefaultTrigger(block: Trigger.() -> Unit) = trigger(
+    VcsTrigger {
+        id = "trigger-vcs-default-trigger-id"
+        branchFilter = "+:<default>"
+    }.apply(block)
+)
+
 object BuildApiReference : Template({
     name = "Dokka Reference Template"
 
@@ -44,13 +62,10 @@ object BuildApiReference : Template({
     params {
         param("teamcity.vcsTrigger.runBuildInNewEmptyBranch", "true")
         param("DOKKA_TEMPLATES_VERSION", DOKKA_TEMPLATES_VERSION)
-        param("DOKKA_TEMPLATE_TASK", "dokkaHtmlMultiModule")
     }
 
     triggers {
-        vcs {
-            branchFilter = "+:<default>"
-        }
+        vcsDefaultTrigger {}
     }
 
     requirements {
@@ -60,9 +75,6 @@ object BuildApiReference : Template({
     steps {
         scriptDropSnapshot {}
         scriptDokkaVersionSync {}
-        gradle {
-            name = "Build dokka html"
-            tasks = "%DOKKA_TEMPLATE_TASK%"
-        }
+        buildDokkaHTML {}
     }
 })
diff --git a/.teamcity/builds/kotlinlang/buidTypes/BuildSitePages.kt b/.teamcity/builds/kotlinlang/buidTypes/BuildSitePages.kt
@@ -2,6 +2,7 @@ package builds.kotlinlang.buidTypes
 
 import builds.apiReferences.kotlinx.coroutines.KotlinxCoroutinesBuildApiReference
 import builds.apiReferences.kotlinx.datetime.KotlinxDatetimeBuildApiReference
+import builds.apiReferences.kotlinx.metadataJvm.KotlinxMetadataJvmBuildApiReference
 import builds.apiReferences.kotlinx.serialization.KotlinxSerializationBuildApiReference
 import builds.kotlinlang.templates.DockerImageBuilder
 import jetbrains.buildServer.configs.kotlin.*
@@ -167,6 +168,17 @@ object BuildSitePages : BuildType({
       }
     }
 
+    dependency(KotlinxMetadataJvmBuildApiReference) {
+      snapshot {
+        reuseBuilds = ReuseBuilds.NO
+        onDependencyFailure = FailureAction.FAIL_TO_START
+      }
+
+      artifacts {
+        artifactRules = "+:pages.zip!** => libs/kotlinx-metadata-jvm/"
+      }
+    }
+
     artifacts(AbsoluteId("Kotlin_KotlinRelease_190_LibraryReferenceLegacyDocs")) {
       buildRule = tag("publish", """
                 +:<default>

diff --git a/docs/kr.tree b/docs/kr.tree
@@ -327,6 +327,7 @@
         <toc-element toc-title="Coroutines (kotlinx.coroutines)" href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"/>
         <toc-element toc-title="Serialization (kotlinx.serialization)" href="https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/"/>
         <toc-element toc-title="Date and time (kotlinx-datetime)" href="https://kotlinlang.org/api/kotlinx-datetime/"/>
+        <toc-element toc-title="JVM Metadata (kotlinx-metadata-jvm)" href="https://kotlinlang.org/api/kotlinx-metadata-jvm/"/>
         <toc-element toc-title="Ktor" href="https://api.ktor.io/"/>
     </toc-element>