Merge branch 'main' into bjhham/pinger-failure-fix

Author: bjhham

build-logic/README.md

@@ -0,0 +1,22 @@
+# build-logic
+
+Build logic shared between Ktor subprojects.
+
+This is similar to `buildSrc`, but uses [composite builds](https://docs.gradle.org/current/userguide/composite_builds.html)
+to prevent projects from becoming out-of-date on any change in `buildSrc`.
+
+This project should be included in the root `settings.gradle.kts`:
+
+`<root project dir>/settings.gradle.kts`
+```kotlin
+includeBuild("build-logic")
+```
+
+`<root project dir>/build.gradle.kts`
+```kotlin
+plugins {
+    id("ktorbuild.base")
+}
+```
+
+*The structure of this project is inspired by the structure used in [Dokka](https://github.com/Kotlin/dokka/tree/v2.0.0/build-logic/src/main/kotlin) and [Gradle](https://github.com/gradle/gradle/tree/v8.12.0/build-logic/jvm/src/main/kotlin).*

build-logic/build.gradle.kts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+plugins {
+    `kotlin-dsl`
+}
+
+dependencies {
+    implementation(libs.kotlin.gradlePlugin)
+    implementation(libs.dokka.gradlePlugin)
+
+    // A hack to make version catalogs accessible from buildSrc sources
+    // https://github.com/gradle/gradle/issues/15383#issuecomment-779893192
+    implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
+}
+
+// Should be synced with gradle/gradle-daemon-jvm.properties
+kotlin {
+    jvmToolchain(21)
+}

build-logic/settings.gradle.kts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+pluginManagement {
+    includeBuild("../build-settings-logic")
+}
+
+plugins {
+    id("conventions-dependency-resolution-management")
+}
+
+dependencyResolutionManagement {
+    // Additional repositories for build-logic
+    @Suppress("UnstableApiUsage")
+    repositories {
+        gradlePluginPortal()
+    }
+}
+
+rootProject.name = "build-logic"

build-logic/src/main/kotlin/ktorbuild.base.gradle.kts

@@ -0,0 +1,7 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import ktorbuild.internal.resolveVersion
+
+version = resolveVersion()

build-logic/src/main/kotlin/ktorbuild.dokka.gradle.kts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import ktorbuild.internal.libs
+import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dependencies {
+    dokkaPlugin(libs.dokka.plugin.versioning)
+}
+
+if (project == rootProject) {
+    tasks.withType<DokkaMultiModuleTask>().configureEach {
+        val version = project.version
+        val dokkaOutputDir = "../versions"
+        val id = "org.jetbrains.dokka.versioning.VersioningPlugin"
+        val config = """{ "version": "$version", "olderVersionsDir":"$dokkaOutputDir" }"""
+
+        outputDirectory = project.layout.projectDirectory.dir("$dokkaOutputDir/$version")
+        pluginsMapConfiguration = mapOf(id to config)
+    }
+}

build-logic/src/main/kotlin/ktorbuild/internal/Version.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package ktorbuild.internal
+
+import org.gradle.api.Project
+
+/**
+ * Resolves the version for the current project based on the defined properties.
+ * Properties "releaseVersion" and "eapVersion" are passed on CI as build parameters:
+ * ```
+ * ./gradlew build -PreleaseVersion=3.0.0
+ * ```
+ */
+internal fun Project.resolveVersion(): String {
+    val projectVersion = version.toString().removeSuffix("-SNAPSHOT")
+    val releaseVersion = findProperty("releaseVersion")?.toString()
+    val eapVersion = findProperty("eapVersion")?.toString()
+
+    return when {
+        releaseVersion != null -> releaseVersion
+        eapVersion != null -> "$projectVersion-eap-$eapVersion"
+        else -> projectVersion
+    }
+}

build-logic/src/main/kotlin/ktorbuild/internal/VersionCatalogs.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package ktorbuild.internal
+
+import org.gradle.accessors.dm.LibrariesForLibs
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.the
+
+/**
+ * Accessor to make version catalog available in build-logic.
+ * See: https://github.com/gradle/gradle/issues/15383#issuecomment-779893192
+ */
+internal val Project.libs: LibrariesForLibs
+    get() = rootProject.the<LibrariesForLibs>()

…le-settings-conventions/build.gradle.kts build-settings-logic/build.gradle.ktsgradle-settings-conventions/build.gradle.kts renamed to build-settings-logic/build.gradle.kts gradle-settings-conventions/build.gradle.kts renamed to build-settings-logic/build.gradle.kts

@@ -15,3 +15,8 @@ dependencies {
     implementation(libs.develocity)
     implementation(libs.develocity.commonCustomUserData)
 }
+
+// Should be synced with gradle/gradle-daemon-jvm.properties
+kotlin {
+    jvmToolchain(21)
+}

…settings-conventions/settings.gradle.kts build-settings-logic/settings.gradle.ktsgradle-settings-conventions/settings.gradle.kts renamed to build-settings-logic/settings.gradle.kts gradle-settings-conventions/settings.gradle.kts renamed to build-settings-logic/settings.gradle.kts

@@ -10,4 +10,4 @@ dependencyResolutionManagement {
     }
 }
 
-rootProject.name = "gradle-settings-conventions"
+rootProject.name = "build-settings-logic"