Add VSS Processor Plugin

.github/actions/setup-project/action.yaml

@@ -4,10 +4,10 @@ description: Setups the gradle and java environment
 runs:
   using: "composite"
   steps:
-    - uses: actions/setup-java@v3
+    - uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
         java-version: '17'
 
     - name: Setup Gradle
-      uses: gradle/gradle-build-action@v2
+      uses: gradle/gradle-build-action@v3

.github/workflows/build-main.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/build-pull-request.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Run Docker Container of Databroker in detached mode"
         run: docker run --pull=always --rm --publish 55556:55556/tcp --detach --name databroker ghcr.io/eclipse/kuksa.val/databroker:master --port 55556 --insecure

.github/workflows/check-license.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # required to grab the history of the PR
         fetch-depth: 0

.github/workflows/commitlint.yaml

@@ -8,6 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: wagoid/commitlint-github-action@v5

.github/workflows/dash.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/deploy-release.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/deploy-snapshot.yaml

@@ -5,15 +5,15 @@ concurrency: snapshot
 on:
   push:
     branches:
-      - main
+      - feature-45-work
 
 jobs:
   deployment:
     if: github.repository == 'eclipse-kuksa/kuksa-android-sdk'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

README.md

@@ -14,7 +14,7 @@ within an Android App. The main functionality consists of fetching, updating and
 
 ## Integration
 
-*build.gradle*
+*build.gradle.kts*
 ```
 implementation("org.eclipse.kuksa:kuksa-sdk:<VERSION>")
 ```

app/build.gradle.kts

@@ -1,5 +1,3 @@
-import org.eclipse.kuksa.property.PropertiesLoader
-
 /*
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -19,9 +17,14 @@ import org.eclipse.kuksa.property.PropertiesLoader
  *
  */
 
+@file:Suppress("UnstableApiUsage")
+
+import org.eclipse.kuksa.property.PropertiesLoader
+
 plugins {
     id("com.android.application")
     id("com.google.devtools.ksp")
+    id("org.eclipse.kuksa.vss-processor-plugin")
     kotlin("plugin.serialization")
     kotlin("android")
 }
@@ -121,6 +124,11 @@ android {
     }
 }
 
+vssProcessor {
+    searchPath = "$projectDir/src/main/assets"
+    fileName = "vss_rel_4.0.yaml"
+}
+
 tasks.withType<Test>().configureEach {
     useJUnitPlatform()
 

build.gradle.kts

@@ -83,3 +83,32 @@ tasks.register("mergeDashFiles") {
         }
     }
 }
+
+// Tasks for included composite builds need to be called separately. For convenience sake we depend on the most used
+// tasks. Every task execution of the main project will then be forwarded to the included build project.
+//
+// We have to manually define the task names because the task() method of the included build throws an error for any
+// unknown task.
+val dependentCompositeTasks = setOf(
+    "setSnapshotVersion",
+    "setReleaseVersion",
+    "publishToMavenLocal",
+    "publishAllPublicationsToOSSRHReleaseRepository",
+)
+
+gradle.projectsEvaluated {
+    val subProjectTasks = tasks + subprojects.flatMap { it.tasks }
+
+    subProjectTasks
+        .filter { dependentCompositeTasks.contains(it.name) }
+        .forEach { task ->
+            val compositeTask = gradle.includedBuilds.map { compositeBuild ->
+                val compositeTaskPath = task.path.substringAfterLast(":")
+                println("Linking composite task - ${compositeBuild.name} <-> ${task.project}:${task.name}")
+
+                compositeBuild.task(":$compositeTaskPath")
+            }
+
+            task.dependsOn(compositeTask)
+        }
+}

buildSrc/src/main/kotlin/publish.gradle.kts

@@ -111,18 +111,12 @@ afterEvaluate {
         )
 
         sign(publishing.publications)
-    }
-}
 
-gradle.taskGraph.whenReady {
-    tasks.withType(Sign::class) {
-        val publishToMavenLocalTask = allTasks.find { it.name.contains("publishToMavenLocal") }
-        val isPublishingToMavenLocal = publishToMavenLocalTask != null
-
-        if (isPublishingToMavenLocal) {
-            println(":${project.name}:$name - Signing is disabled (publishToMavenLocal)")
-        }
+        setRequired({
+            val publishToMavenLocalTask = gradle.taskGraph.allTasks.find { it.name.contains("ToMavenLocal") }
+            val isPublishingToMavenLocal = publishToMavenLocalTask != null
 
-        onlyIf { !isPublishingToMavenLocal } // disable signing when publishing to MavenLocal
+            !isPublishingToMavenLocal // disable signing when publishing to MavenLocal
+        })
     }
 }

docs/QUICKSTART.md

@@ -4,7 +4,7 @@ Get instantly bootstrapped into the world of the KUKSA SDK with the following co
 
 ## Integration
 
-*build.gradle*
+*build.gradle.kts*
 ```
 implementation("org.eclipse.kuksa:kuksa-sdk:<VERSION>")
 ```
@@ -153,9 +153,21 @@ For a more convenient usage you can opt in to auto generate Kotlin models via [S
 of the same specification the Databroker uses. For starters you can retrieve an extensive default specification from the
 release page of the [COVESA Vehicle Signal Specification GitHub repository](https://github.com/COVESA/vehicle_signal_specification/releases).
 
-*build.gradle*
+*build.gradle.kts*
 ```
-ksp("org.eclipse.kuksa:vss-processor:<VERSION>")
+plugins {
+    id("org.eclipse.kuksa.vss-processor-plugin")
+}
+
+dependencies {
+    ksp("org.eclipse.kuksa:vss-processor:<VERSION>")
+}
+
+// Optional - See plugin documentation. Files inside the main assets are used automatically.
+vssProcessor {
+    searchPath = "$projectDir/src/main/assets"
+    fileName = "vss_rel_4.0.yaml"
+}
 ```
 
 Use the new [`VssDefinition`](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt) annotation and provide the path to the specification file (Inside the assets folder).

gradle.properties

@@ -1,4 +1,3 @@
-android.defaults.buildfeatures.buildconfig=true
 android.nonFinalResIds=false
 android.nonTransitiveRClass=true
 android.useAndroidX=true

gradle/libs.versions.toml

@@ -1,6 +1,6 @@
 [versions]
 activityKtx = "1.8.0"
-androidGradlePlugin = "8.1.3" # Check with detekt table first: https://detekt.dev/docs/introduction/compatibility/
+androidGradlePlugin = "8.2.2" # Check with detekt table first: https://detekt.dev/docs/introduction/compatibility/
 datastore = "1.0.0"
 constraintlayoutCompose = "1.0.1"
 datastorePreferences = "1.0.0"
@@ -71,3 +71,4 @@ grpc-protoc-java-gen = { group = "io.grpc", name = "protoc-gen-grpc-java", versi
 
 [plugins]
 dokka = { id = "org.jetbrains.dokka", version.ref = "kotlin" }
+pluginPublishing = { id = "com.gradle.plugin-publish", version = "1.2.1" }

kuksa-sdk/build.gradle.kts

@@ -92,7 +92,7 @@ dependencies {
     testImplementation(libs.mockk)
 }
 
-configure<Publish_gradle.PublishPluginExtension> {
+publish {
     mavenPublicationName = "release"
     componentName = "release"
     description = "Android Connectivity Library for the KUKSA Databroker"

samples/build.gradle.kts

@@ -20,6 +20,7 @@
 plugins {
     id("com.android.application")
     id("com.google.devtools.ksp")
+    id("org.eclipse.kuksa.vss-processor-plugin")
     kotlin("android")
 }
 
@@ -54,6 +55,11 @@ android {
     }
 }
 
+vssProcessor {
+    searchPath = "$projectDir/src/main/assets"
+    fileName = "vss_rel_4.0.yaml"
+}
+
 dependencies {
     implementation(project(":kuksa-sdk")) // org.eclipse.kuksa.kuksa-sdk:<VERSION>
     ksp(project(":vss-processor")) // org.eclipse.kuksa.vss-processor:<VERSION>

settings.gradle.kts

@@ -18,6 +18,8 @@
  */
 
 pluginManagement {
+    includeBuild("vss-processor-plugin")
+
     repositories {
         gradlePluginPortal()
         google()
@@ -26,6 +28,7 @@ pluginManagement {
 
     plugins {
         id("com.google.devtools.ksp") version "1.9.0-1.0.11"
+        id("org.eclipse.kuksa.vss-processor-plugin") // Always take the newest version since it's locally included
         kotlin("jvm") version "1.9.0-1.0.11"
         kotlin("plugin.serialization") version "1.9.0"
     }
@@ -40,6 +43,8 @@ dependencyResolutionManagement {
     }
 }
 
+rootProject.name = "kuksa-android-sdk"
+
 include(":app")
 include(":kuksa-sdk")
 include(":samples")

vss-core/build.gradle.kts

@@ -21,7 +21,6 @@
 
 plugins {
     kotlin("jvm")
-    `maven-publish`
     publish
     alias(libs.plugins.dokka)
 }
@@ -49,7 +48,7 @@ tasks.withType<Test>().configureEach {
     }
 }
 
-configure<Publish_gradle.PublishPluginExtension> {
+publish {
     mavenPublicationName = "release"
     componentName = "java"
     description = "Vehicle Signal Specification (VSS) Core Module of the KUKSA SDK"

vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt

@@ -21,10 +21,25 @@ package org.eclipse.kuksa.vsscore.annotation
 
 /**
  * Add this annotation to any class to trigger the model generation (Kotlin Symbol Processing) for the given
- * Vehicle Signal Specification definition file. Only .yaml files are currently supported. The searched root folder
- * is the assets folder (example path: app/src/main/assets).
+ * Vehicle Signal Specification definition file. Only .yaml files are currently supported. Use the
+ * "VSS Processor Plugin" to provide the Symbol Processor with the necessary definition file(s). Then provide the file
+ * name via the [vssDefinitionName] parameter (The path can be ignored).
  *
- * ### Example
+ * ### Plugin Example
+ *
+ * ```
+ * plugins {
+ *     id("org.eclipse.kuksa.vss-processor-plugin") version "<VERSION>"
+ * }
+ *
+ * // Optional - See plugin documentation. Files inside the main assets are used automatically.
+ * vssProcessor {
+ *     searchPath = "$projectDir/src/main/assets"
+ *     fileName = "vss_rel_4.0.yaml"
+ * }
+ * ```
+ *
+ * ### Annotation Example
  *
  * ```
  * @VssDefinition("vss_rel_4.0.yaml")
@@ -36,10 +51,8 @@ package org.eclipse.kuksa.vsscore.annotation
  * then the incremental compiler for KSP needs to be disabled explicitly in the gradle properties.
  * ```
  * <ksp.incremental=false>
- *
- * @param vssDefinitionPath the path to the definition file
  * ```
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.SOURCE)
-annotation class VssDefinition(val vssDefinitionPath: String)
+annotation class VssDefinition(val vssDefinitionName: String)

vss-processor-plugin/.gitignore

@@ -0,0 +1 @@
+/build