build: Introduce a convention plugin for plugins

Introduce the new `ort-plugin-conventions` plugin to simplify the
configuration of plugin projects.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>

buildSrc/build.gradle.kts

@@ -40,5 +40,6 @@ dependencies {
     implementation(libs.plugin.dokkatoo)
     implementation(libs.plugin.graalVmNativeImage)
     implementation(libs.plugin.kotlin)
+    implementation(libs.plugin.ksp)
     implementation(libs.plugin.mavenPublish)
 }

buildSrc/src/main/kotlin/ort-plugin-conventions.gradle.kts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2024 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+    id("ort-publication-conventions")
+
+    // Apply third-party plugins.
+    id("com.google.devtools.ksp")
+}
+
+dependencies {
+    ksp(project(":plugins:compiler"))
+}

gradle/libs.versions.toml

@@ -71,7 +71,6 @@ download = { id = "de.undercouch.download", version.ref = "downloadPlugin" }
 gitSemver = { id = "com.github.jmongard.git-semver-plugin", version.ref = "gitSemverPlugin" }
 ideaExt = { id = "org.jetbrains.gradle.plugin.idea-ext", version.ref = "ideaExtPlugin" }
 kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlinPlugin" }
-ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 versions = { id = "com.github.ben-manes.versions", version.ref = "versionsPlugin" }
 
 [libraries]
@@ -81,6 +80,7 @@ plugin-detekt-formatting = { module = "io.gitlab.arturbosch.detekt:detekt-format
 plugin-dokkatoo = { module = "dev.adamko.dokkatoo:dokkatoo-plugin", version.ref = "dokkatooPlugin" }
 plugin-graalVmNativeImage = { module = "org.graalvm.buildtools:native-gradle-plugin", version.ref = "graalVmNativeImagePlugin" }
 plugin-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlinPlugin" }
+plugin-ksp = { module = "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin", version.ref = "ksp" }
 plugin-mavenPublish = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "mavenPublishPlugin" }
 
 asciidoctorj = { module = "org.asciidoctor:asciidoctorj", version.ref = "asciidoctorj" }

plugins/advisors/nexus-iq/build.gradle.kts

@@ -19,10 +19,7 @@
 
 plugins {
     // Apply precompiled plugins.
-    id("ort-library-conventions")
-
-    // Apply third-party plugins.
-    alias(libs.plugins.ksp)
+    id("ort-plugin-conventions")
 }
 
 dependencies {
@@ -34,5 +31,4 @@ dependencies {
     implementation(projects.utils.ortUtils)
 
     ksp(projects.advisor)
-    ksp(projects.plugins.compiler)
 }

plugins/advisors/oss-index/build.gradle.kts

@@ -19,10 +19,7 @@
 
 plugins {
     // Apply precompiled plugins.
-    id("ort-library-conventions")
-
-    // Apply third-party plugins.
-    alias(libs.plugins.ksp)
+    id("ort-plugin-conventions")
 }
 
 dependencies {
@@ -34,7 +31,6 @@ dependencies {
     implementation(projects.utils.ortUtils)
 
     ksp(projects.advisor)
-    ksp(projects.plugins.compiler)
 
     testImplementation(libs.wiremock)
 }

plugins/advisors/osv/build.gradle.kts

@@ -19,10 +19,7 @@
 
 plugins {
     // Apply precompiled plugins.
-    id("ort-library-conventions")
-
-    // Apply third-party plugins.
-    alias(libs.plugins.ksp)
+    id("ort-plugin-conventions")
 }
 
 dependencies {
@@ -38,5 +35,4 @@ dependencies {
     implementation(libs.kotlinx.serialization.json)
 
     ksp(projects.advisor)
-    ksp(projects.plugins.compiler)
 }

plugins/advisors/vulnerable-code/build.gradle.kts

@@ -19,10 +19,7 @@
 
 plugins {
     // Apply precompiled plugins.
-    id("ort-library-conventions")
-
-    // Apply third-party plugins.
-    alias(libs.plugins.ksp)
+    id("ort-plugin-conventions")
 }
 
 dependencies {
@@ -34,7 +31,6 @@ dependencies {
     implementation(projects.utils.ortUtils)
 
     ksp(projects.advisor)
-    ksp(projects.plugins.compiler)
 
     testImplementation(libs.wiremock)
 }

plugins/api/README.md

@@ -113,37 +113,27 @@ Here, the `serverUrl` property has a default value, the `timeout` property is re
 
 ### Gradle Configuration
 
-A Gradle module that contains an ORT plugin implementation must apply the `com.google.devtools.ksp` Gradle plugin:
+A Gradle module that contains an ORT plugin implementation must apply the `com.google.devtools.ksp` Gradle plugin and add dependencies to the ORT compiler plugin and the API of the implemented extension point to the KSP configuration:
 
 ```kotlin
 plugins {
     id("com.google.devtools.ksp:[version]")
 }
-```
-
-Or in the ORT codebase:
-
-```kotlin
-plugins {
-    alias(libs.plugins.ksp)
-}
-```
-
-It also must add the ORT plugin API and the API of the implemented extension point to the KSP configuration.
-For example, an advisor plugin implementation would add the following dependencies:
 
-```kotlin
 dependencies {
     ksp("org.ossreviewtoolkit:advisor:[version]")
-    ksp("org.ossreviewtoolkit:plugins-compiler:[version]")
+    ksp("org.ossreviewtoolkit:compiler:[version]")
 }
 ```
 
-Or in the ORT codebase:
+In the ORT codebase, the `ort-plugin-conventions` should be applied so that only a dependency on the extension point API is required:
 
 ```kotlin
+plugins {
+    id("ort-plugin-conventions")
+}
+
 dependencies {
     ksp(projects.advisor)
-    ksp(projects.plugins.api)
 }
 ```