feat: add nemerosa versioning plugin (#3)

* feat: add nemerosa versioning plugin * chore: change version to full in local development * chore: remove gradle properties/minor improvements * chore: move plugin properties to build folder * chore(generate-vex): remove default value from props for metadata --------- Co-authored-by: Patrick Mirwald <[email protected]>
Liftric · Jul 18, 2023 · 6e595c1 · 6e595c1
1 parent 4e28099
commit 6e595c1
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 21 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -5,6 +5,12 @@ plugins {
     alias(libs.plugins.kotlinSerialization)
     alias(libs.plugins.dockerCompose)
     alias(libs.plugins.gradlePluginPublish)
+    alias(libs.plugins.versioning)
+}
+
+group = "com.liftric"
+version = with(versioning.info) {
+    if (branch == "HEAD" && dirty.not()) tag else full
 }
 
 repositories {
@@ -23,6 +29,7 @@ dockerCompose {
 }
 
 val integrationTest = sourceSets.create("integrationTest")
+
 tasks {
     val test by existing
     withType<Test> {
@@ -43,28 +50,32 @@ tasks {
     }
     dockerCompose.isRequiredBy(integrationTestTask)
 
+    val pluginPropertiesBuildFolder = file("$buildDir/compileProperties/")
     val propertiesTask = register<WriteProperties>("writePluginProperties") {
-        outputFile = file("src/main/resources/plugin.properties")
-        property("vendor", project.property("pluginVendor").toString())
-        property("name", project.property("pluginName").toString())
-        property("version", project.property("pluginVersion").toString())
+        outputFile = pluginPropertiesBuildFolder.resolve("plugin.properties")
+        property("vendor", "Liftric")
+        property("name", rootProject.name)
+        property("version", rootProject.version)
+    }
+    sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME).resources.srcDir(pluginPropertiesBuildFolder)
+
+    withType(ProcessResources::class.java) {
+        dependsOn(propertiesTask)
     }
 }
 
-tasks.named("build") {
+tasks.named("publishPlugins") {
     dependsOn("writePluginProperties")
 }
 
-
 gradlePlugin {
     testSourceSets(integrationTest)
     plugins {
         create("dependency-track-companion-plugin") {
-            id = "${project.property("pluginGroup")}.${project.property("pluginName")}"
-            implementationClass = "${project.property("pluginGroup")}.dtcp.DepTrackCompanionPlugin"
-            displayName = project.property("pluginName").toString()
-            version = project.property("pluginVersion").toString()
-            group = project.property("pluginGroup").toString()
+            id = "$group.$name"
+            implementationClass = "$group.dtcp.DepTrackCompanionPlugin"
+            displayName = name
+            description = "Common tasks for Dependency Track interaction, like SBOM upload or VEX Generation"
         }
     }
 }

diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1 @@
 kotlin.code.style=official
-pluginGroup=com.liftric
-pluginVersion=1.0.0
-pluginName=dependency-track-companion-plugin
-pluginVendor=Liftric
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -9,6 +9,7 @@ pluginManagement {
                 version("cyclonedx-core-java", "7.3.2")
                 version("junit-bom", "5.9.3")
 
+                plugin("versioning", "net.nemerosa.versioning").version("3.0.0")
                 plugin("dockerCompose", "com.avast.gradle.docker-compose").version("0.16.12")
                 plugin("kotlinJvm", "org.jetbrains.kotlin.jvm").versionRef("kotlin")
                 plugin("kotlinSerialization", "org.jetbrains.kotlin.plugin.serialization").versionRef("kotlin")

diff --git a/src/main/kotlin/com/liftric/dtcp/tasks/GenerateVex.kt b/src/main/kotlin/com/liftric/dtcp/tasks/GenerateVex.kt
@@ -81,9 +81,9 @@ abstract class GenerateVexTask : DefaultTask() {
         vexFile.metadata.timestamp = Date()
         vexFile.metadata.component = sbom.metadata.component ?: Component()
         val pluginData = Tool().apply {
-            vendor = props.getProperty("vendor", "Liftric")
-            name = props.getProperty("name", "Liftric")
-            version = props.getProperty("version", "Liftric")
+            vendor = props.getProperty("vendor")
+            name = props.getProperty("name")
+            version = props.getProperty("version")
         }
         vexFile.metadata.tools = listOf(pluginData)
     }

diff --git a/src/main/resources/plugin.properties b/src/main/resources/plugin.properties