Merge pull request #4762 from JetBrains/ktl-2134-add-kgp-references

KTL-2134: add kgp references versions

Author: zoobestik

.teamcity/.gitignore

@@ -1 +1,2 @@
-/target
+/target
+*.iml

.teamcity/BuildParams.kt

@@ -1,4 +1,6 @@
 import references.builds.compose.ComposeMultiplatformCore
+import references.builds.kgp.KotlinGradleAPI
+import common.extensions.VCS
 
 object BuildParams {
   const val DOKKA_TEMPLATES_VERSION = "2.0.0"
@@ -38,6 +40,11 @@ object BuildParams {
   const val KOTLINX_METADATA_RELEASE_TAG = KOTLIN_RELEASE_TAG
   const val KOTLINX_METADATA_TITLE = KOTLINX_METADATA_ID
 
+  val KGP_REFERENCE = KotlinGradleAPI {
+    addVersion("2.1.20", VCS.branch("whyoleg/dokka2-sync"))
+//    addVersion("2.2.0", VCS.branch("2.2.0"))
+  }
+
   val API_COMPOSE = ComposeMultiplatformCore {
     addVersion("1.8.0", "api-reference/1.8")
   }
@@ -51,8 +58,8 @@ object BuildParams {
     "api/$KOTLINX_SERIALIZATION_ID",
     "api/$KOTLINX_DATETIME_ID",
     "api/$KOTLINX_IO_ID",
-    "api/$KGP_ID",
     "api/$KOTLINX_METADATA_ID",
+    "api/${KGP_REFERENCE.urlPart}",
     "api/${API_COMPOSE.urlPart}",
   )
 }

.teamcity/common/extensions/references.kt

@@ -175,6 +175,6 @@ fun BuildSteps.dokkaBuildHtml(version: String? = null, init: GradleBuildStep.()
     id = "step-build-dokka-html-id"
     name = "Build dokka html"
     tasks = "dokkaHtmlMultiModule"
-    gradleParams = "${if (version != null) "-PdeployVersion=\"$version\" " else ""}--no-daemon --no-configuration-cache"
+    gradleParams = "${if (version != null) """-PdeployVersion=$version """ else ""}--no-daemon --no-configuration-cache"
     useGradleWrapper = true
 }.apply(init)

.teamcity/references/BuildApiPages.kt

@@ -98,10 +98,11 @@ fun scriptDropSnapshot(init: ScriptBuildStep.() -> Unit = {}): BuildStep = Scrip
     """.trimIndent()
 }.apply(init)
 
-fun scriptBuildHtml(init: GradleBuildStep.() -> Unit = {}): BuildStep = GradleBuildStep {
+fun scriptBuildHtml(version: String? = null, init: GradleBuildStep.() -> Unit = {}): BuildStep = GradleBuildStep {
     id = "step-build-dokka-html-id"
     name = "Build dokka html"
     tasks = "dokkaHtmlMultiModule"
+    gradleParams = "${if (version != null) "-PdeployVersion=\"$version\" " else ""}--no-daemon --no-configuration-cache"
     useGradleWrapper = true
 }.apply(init)
 
@@ -133,8 +134,8 @@ fun scriptNoRobots(pagesRoot: String, block: ScriptBuildStep.() -> Unit = {}) =
     //language=sh
     scriptContent = """
         # replace with print
-        # find . -type f \( -regex "^./\d\+\.\d\+\(\.\d\)\?/.\+\.html${'$'}" \) -exec echo {} \; -exec sed -i -E 's/(<head[^>]*>)/\1<meta name="robots" content="noindex, nofollow">/g' {} \;
-        find . -type f \( -regex "^./\d\+\.\d\+\(\.\d\)\?/.\+\.html${'$'}" \) -exec sed -i -E 's/(<head[^>]*>)/\1<meta name="robots" content="noindex, nofollow">/g' {} \;
+        find . -type f \( -regex '\./\(older/\)\?[0-9]\+\.[0-9]\+\([0-9]\+\)\?.\+\.html${'$'}' \) \
+            -exec sed -i -E 's/(<head[^>]*>)/\1<meta name="robots" content="noindex, nofollow">/g' {} \;
     """.trimIndent()
     dockerImage = "alpine"
 }.apply(block)

.teamcity/references/BuildApiReferencesProject.kt

@@ -1,6 +1,7 @@
 package references
 
 import BuildParams.API_COMPOSE
+import BuildParams.KGP_REFERENCE
 import jetbrains.buildServer.configs.kotlin.Project
 import references.builds.kgp.KotlinGradlePluginBuildApiReference
 import references.builds.kgp.KotlinGradlePluginBuildSearchIndex
@@ -66,4 +67,5 @@ object BuildApiReferencesProject : Project({
     template(PrepareDokkaTemplate)
 
     subProject(API_COMPOSE.project)
+    subProject(KGP_REFERENCE.project)
 })

.teamcity/references/builds/kgp/KotlinGradleAPI.kt

@@ -0,0 +1,28 @@
+package references.builds.kgp
+
+import BuildParams.KGP_TITLE
+import common.ReferenceProject
+import common.extensions.apiReference
+import common.extensions.dokkaBuildHtml
+
+class KotlinGradleAPI(init: KotlinGradleAPI.() -> Unit) : ReferenceProject("kotlin-gradle-plugin", KGP_TITLE) {
+    init {
+        init()
+        build()
+    }
+
+    fun addVersion(version: String, tagsOrBranch: String) = addReference(version) {
+        apiReference(
+            version = version,
+            gitBranch = tagsOrBranch,
+            gitUrl = "[email protected]:JetBrains/kotlin.git",
+            templateDir = "build/api-reference/templates",
+            pagesDir = "libraries/tools/gradle/documentation/build/documentation/kotlinlang",
+            previousVersionDir = "libraries/tools/gradle/documentation/build/documentation/kotlinlangOld",
+        ) {
+            dokkaBuildHtml(version) {
+                tasks = ":gradle:documentation:dokkaKotlinlangDocumentation"
+            }
+        }
+    }
+}

.teamcity/references/extensions.kt

@@ -16,15 +16,3 @@ fun Dependencies.dependsOnDokkaTemplate(build: BuildType, artifactPath: String =
     }
   }
 }
-
-fun Dependencies.dependsOnDokkaPagesJson(build: BuildType) {
-  dependency(build) {
-    snapshot {
-      onDependencyFailure = FailureAction.FAIL_TO_START
-      onDependencyCancel = FailureAction.CANCEL
-    }
-    artifacts {
-      artifactRules = "+:pages.zip!scripts/pages.json => api-references"
-    }
-  }
-}

.teamcity/references/templates/PrepareDokkaTemplate.kt

@@ -1,10 +1,11 @@
 package references.templates
 
+import jetbrains.buildServer.configs.kotlin.BuildTypeSettings
 import jetbrains.buildServer.configs.kotlin.Template
 import jetbrains.buildServer.configs.kotlin.buildSteps.script
+import vcsRoots.KotlinLangOrg
 
-object PrepareDokkaTemplate: Template({
-  name = "Build Custom HTML Template"
+fun BuildTypeSettings.configureReferenceTemplate() {
   artifactRules = """
       dokka-templates/** => dokka-templates
   """.trimIndent()
@@ -13,15 +14,6 @@ object PrepareDokkaTemplate: Template({
     doesNotContain("teamcity.agent.name", "windows")
   }
 
-  params {
-//      param("env.ALGOLIA_INDEX_NAME", "")
-      param("env.API_REFERENCE_NAME", "")
-  }
-
-  vcs {
-    root(vcsRoots.KotlinLangOrg)
-  }
-
   steps {
     script {
       name = "Fix npm sharp platform related issue"
@@ -44,4 +36,14 @@ object PrepareDokkaTemplate: Template({
       dockerImage = "node:16-alpine"
     }
   }
+}
+
+object PrepareDokkaTemplate : Template({
+  configureReferenceTemplate()
+
+  name = "Build Custom HTML Template"
+
+  vcs {
+    root(KotlinLangOrg)
+  }
 })

.teamcity/settings.kts

@@ -22,7 +22,7 @@ To debug in IntelliJ Idea, open the 'Maven Projects' tool window (View
 'Debug' option is available in the context menu for the task.
 */
 
-version = "2024.07"
+version = "2025.03"
 
 project {
 

.teamcity/templates/DockerImageBuilder.kt

@@ -3,6 +3,7 @@ package templates
 import jetbrains.buildServer.configs.kotlin.AbsoluteId
 import jetbrains.buildServer.configs.kotlin.FailureAction
 import jetbrains.buildServer.configs.kotlin.Template
+import jetbrains.buildServer.configs.kotlin.buildFeatures.dockerRegistryConnections
 import jetbrains.buildServer.configs.kotlin.buildFeatures.dockerSupport
 import kotlinlang.builds.BuildKotlinGrammar
 
@@ -20,7 +21,7 @@ object DockerImageBuilder : Template({
   }
 
   features {
-    dockerSupport {
+    dockerRegistryConnections {
       loginToRegistry = on {
         dockerRegistryId = "PROJECT_EXT_357"
       }