chore: add git commit to generated buildconfig

Author: sureshg

common/build.gradle.kts

@@ -1,4 +1,5 @@
 import common.jvmArguments
+import common.versionCatalogMapOf
 
 plugins {
   application
@@ -15,9 +16,7 @@ application {
 
 buildConfig {
   version = project.version.toString()
-  val catalog = project.versionCatalogs.named("libs")
-  val catalogMap = catalog.versionAliases.associateWith { catalog.findVersion(it).get().toString() }
-  catalogVersions = catalogMap
+  catalogVersions = project.versionCatalogMapOf()
 }
 
 dependencies {

common/src/commonMain/kotlin/dev/suresh/Greeting.kt

@@ -23,11 +23,14 @@ class Greeting {
   fun greeting() =
       """
       | Platform       : Kotlin $platform
-      | Build Time     : ${BuildConfig.time}
+      | Build Time     : ${BuildConfig.buildTime}
       | Build Version  : ${BuildConfig.version}
       | Java Version   : ${BuildConfig.java}
       | Kotlin Version : ${KotlinVersion.CURRENT}
       | Gradle Version : ${BuildConfig.gradle}
+      | Git Hash       : ${BuildConfig.gitHash}
+      | Git Message    : ${BuildConfig.gitMessage}
+      | Git Tag        : ${BuildConfig.gitTags}
       | ${KData("Foo", 20, "test")}
       | ${kotlinxTests()}
       """

gradle/build-logic/common-plugins/src/main/kotlin/common/ProjectExtns.kt

@@ -106,6 +106,19 @@ val Project.incubatorModules
         .joinToString(",") { it.substringBefore("@").trim() }
   }
 
+/**
+ * Retrieves a map of version aliases and their corresponding versions from the project's version
+ * catalog.
+ *
+ * @param name The name of the version catalog. Defaults to "libs" if not specified.
+ * @return A map where the keys are the version aliases and the values are their corresponding
+ *   versions.
+ */
+fun Project.versionCatalogMapOf(name: String = "libs") = run {
+  val catalog = catalogs.named(name)
+  catalog.versionAliases.associateWith { catalog.findVersion(it).get().toString() }
+}
+
 /**
  * Print all the catalog version strings and it's values.
  *

gradle/build-logic/common-plugins/src/main/kotlin/common/Repo.kt

@@ -44,7 +44,6 @@ object Repo {
    * @param artifactId the artifact ID of the Maven artifact
    * @return the latest download URL for the specified Maven artifact
    */
-  fun latestDownloadUrl(groupId: String, artifactId: String): String {
-    return "https://search.maven.org/remote_content?g=${groupId}&a=${artifactId}&v=LATEST"
-  }
+  fun latestDownloadUrl(groupId: String, artifactId: String) =
+      "https://search.maven.org/remote_content?g=${groupId}&a=${artifactId}&v=LATEST"
 }

gradle/build-logic/common-plugins/src/main/kotlin/plugins/misc.gradle.kts

@@ -48,7 +48,7 @@ spotless {
   }
 
   format("misc") {
-    target("**/*.md", "**/.gitignore")
+    target("**/*.md", "**/.gitignore", "**/.kte")
     trimTrailingWhitespace()
     indentWithSpaces(2)
     endWithNewline()

gradle/build-logic/common-plugins/src/main/kotlin/tasks/BuildConfig.kt

@@ -1,5 +1,6 @@
 package tasks
 
+import com.javiersc.semver.project.gradle.plugin.SemverExtension
 import gg.jte.ContentType
 import gg.jte.TemplateEngine
 import gg.jte.output.StringOutput
@@ -8,9 +9,7 @@ import org.gradle.api.DefaultTask
 import org.gradle.api.Project
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.tasks.*
-import org.gradle.kotlin.dsl.listProperty
-import org.gradle.kotlin.dsl.mapProperty
-import org.gradle.kotlin.dsl.property
+import org.gradle.kotlin.dsl.*
 import org.gradle.language.base.plugins.LifecycleBasePlugin
 
 @CacheableTask
@@ -38,14 +37,27 @@ abstract class BuildConfig @Inject constructor(private val extension: BuildConfi
     val file = dir.resolve("$className.kt")
     logger.quiet("Generated build config file: ${file.absolutePath}")
 
+    // Get git commit info
+    val gitCommit = run {
+      val commit = project.the<SemverExtension>().commits.get().first()
+      mapOf(
+          "gitHash" to commit.hash,
+          "gitMessage" to commit.message,
+          "gitTimestampEpochSecond" to commit.timestampEpochSecond.toString(),
+          "gitTags" to commit.tags.joinToString(),
+      )
+    }
+
     // the<VersionCatalogsExtension>().named("libs").
     val params =
         mapOf(
             "className" to className,
             "pkg" to pkg,
             "version" to extension.version.get(),
+            "gitCommit" to gitCommit,
             "catalogVersions" to extension.catalogVersions.get(),
-            "dependencies" to extension.dependencies.get())
+            "dependencies" to extension.dependencies.get(),
+        )
 
     val content = StringOutput()
     val tmplEngine =

gradle/build-logic/common-plugins/src/main/resources/BuildConfig.kte

@@ -7,15 +7,20 @@
 @param version: String
 @param catalogVersions: Map<String, String>
 @param dependencies: List<String>
+@param gitCommit: Map<String, String>
 
 /* GENERATED, DO NOT EDIT MANUALLY! */
 @if(pkg.isNotBlank())package ${pkg}@endif
 object ${className} {
 
-   const val time = "${LocalDateTime.now().toString()}"
+   const val buildTime = "${LocalDateTime.now().toString()}"
 
    const val version = "${version}"
 
+   @for((k,v) in gitCommit)
+   const val ${k} = "${v}"
+   @endfor
+
    @for((k,v) in catalogVersions)
    const val ${k.camelCase} = "${v}"
    @endfor

gradle/libs.versions.toml

@@ -46,7 +46,7 @@ dokka                          = "1.8.20"
 intellij-markdown              = "0.4.1"
 jgit                           = "6.5.0.202303070854-r"
 jte                            = "3.0.1"
-junit                          = "5.10.0-RC2"
+junit                          = "5.10.0"
 koin                           = "3.4.1"
 kotest                         = "5.6.2"
 mockk                          = "1.13.5"