chore: app,doc,coverage publishing using Github actions.

Author: sureshg

.github/config/configuration.json

@@ -36,7 +36,8 @@
       "labels": [
         "deps",
         "dependencies",
-        "chore(deps)"
+        "chore(deps)",
+        "build(deps)"
       ]
     },
     {

.github/release.yml

@@ -34,6 +34,7 @@ changelog:
         - deps
         - dependencies
         - chore(deps)
+        - build(deps)
     - title: Other Changes 🖇️
       labels:
         - "*"

.github/workflows/build.yml

@@ -46,6 +46,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: false
 
+    outputs:
+      name: ${{ steps.gradle-build.outputs.name }}
+      group: ${{ steps.gradle-build.outputs.group }}
+      version: ${{ steps.gradle-build.outputs.version }}
+
     steps:
       - name: 🛎️ Check out the source code
         uses: actions/checkout@v3
@@ -74,7 +79,7 @@ jobs:
       - name: 🏗️ Gradle Build & Run
         id: gradle-build
         run: |
-          ./gradlew build
+          ./gradlew ciBuild
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           JOB_CONTEXT: ${{ toJSON(job) }}
@@ -84,32 +89,42 @@ jobs:
           STRATEGY_CONTEXT: ${{ toJSON(strategy) }}
           MATRIX_CONTEXT: ${{ toJSON(matrix) }}
 
-      - name: 📤 Uploading ${{ matrix.os }} executable jar
-        if: steps.gradle-build.outcome == 'success' && runner.os == 'XLinux'
+      - name: 📤 Uploading ${{ matrix.os }} build artifacts
+        if: steps.gradle-build.outcome == 'success' && runner.os == 'Linux'
         uses: actions/upload-artifact@v3
         with:
-          name: ${{ steps.gradle-build.outputs.appjar_name }}
+          name: ${{ steps.gradle-build.outputs.dist_name }}.zip
           path: |
-            ${{ steps.gradle-build.outputs.appjar_path }}
+            backend/build/distributions/backend-*.zip
           if-no-files-found: error
 
-      - name: 🚀 Deploy html docs to 🕸️website
-        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'XLinux'
+      - name: 🕸Deploy the webapp to Github Pages
+        if: steps.gradle-build.outcome == 'success' && runner.os == 'Linux'
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: web/build/dist/js/productionExecutable
+          target-folder: app
+          clean: true
+          commit-message: 'web: Deployed web app'
+
+      - name: 🏖️ Publish documentation to Github Pages
+        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'Linux'
         uses: JamesIves/[email protected]
         with:
-          branch: main
-          folder: build/dokka
-          target-folder: docs/apidoc/
+          branch: gh-pages
+          folder: build/dokka/htmlMultiModule
+          target-folder: docs
           clean: true
-          commit-message: 'doc: Deployed dokka website'
+          commit-message: 'doc: Deployed dokka html documentation'
 
-      - name: 🏖️ Deploy coverage report to website
-        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'XLinux'
+      - name: 🏖️ Publish coverage report to Github Pages
+        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'Linux'
         uses: JamesIves/[email protected]
         with:
-          branch: main
-          folder: build/reports
-          target-folder: docs/reports/
+          branch: gh-pages
+          folder: build/reports/kover/html
+          target-folder: reports
           clean: true
           commit-message: 'doc: Deployed coverage report'
 
@@ -130,4 +145,46 @@ jobs:
             git commit --message "doc: Update generated.txt"
             git push
             # git push origin HEAD:${{ github.event.repository.default_branch }}
-          fi
+          fi
+  
+
+  # GitHub Release Action on tag push
+  release:
+    name: 🚰 Release new version.
+    needs: [ build ]
+    if: startsWith(github.ref, 'refs/tags/') && needs.build.result == 'success'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 🛎️Check out the source code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: ⚙️Build Changelog
+        id: github_release
+        uses: mikepenz/release-changelog-builder-action@v4
+        with:
+          configuration: ".github/config/configuration.json"
+          commitMode: true
+          ignorePreReleases: ${{ !contains(github.ref, '-') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: ⏬Download all the build artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: release-artifacts
+
+      - name: ✨Github Release (version = ${{ needs.build.outputs.version }})
+        uses: softprops/action-gh-release@v1
+        with:
+          # body_path: ${{ github.workspace }}-CHANGELOG.txt
+          body: ${{ steps.github_release.outputs.changelog }}
+          files: |
+            ${{ github.workspace }}/release-artifacts/**
+          generate_release_notes: true
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

build.gradle.kts

@@ -1,5 +1,14 @@
+import common.commonProjectName
+
 plugins {
   plugins.common
   plugins.misc
   kotlin("multiplatform") apply false
 }
+
+// Multi module single coverage report
+dependencies {
+  kover(project(":$commonProjectName"))
+  kover(project("backend"))
+  kover(project("web"))
+}

gradle/build-logic/common-plugins/build.gradle.kts

@@ -54,7 +54,7 @@ gradlePlugin {
 
     // Uncomment the id to change plugin id for this pre-compiled plugin
     named("plugins.common") {
-      // id = "dev.suresh.gradle.plugins.common"
+      // id = "build.plugins.common"
       displayName = "Common build-logic plugin"
       description = "Common pre-compiled script plugin"
       tags = listOf("Common Plugin", "build-logic")

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

@@ -1,14 +1,28 @@
 package common
 
 import java.io.File
+import java.nio.file.FileSystems
+import java.nio.file.Files
+import java.nio.file.Path
 import java.text.DecimalFormat
+import java.text.NumberFormat
 import kotlin.math.ln
 import kotlin.math.pow
+import kotlin.properties.ReadOnlyProperty
+import kotlin.reflect.full.isSubtypeOf
+import kotlin.reflect.typeOf
+
+internal val DEC_FORMAT = DecimalFormat("#.##")
 
 /** OS temp location */
 val tmp: String = "${System.getProperty("java.io.tmpdir")}${File.separator}"
 
-internal val DEC_FORMAT = DecimalFormat("#.##")
+/** Returns the file size in a human-readable format. */
+val File.displaySize
+  get() = length().byteDisplaySize()
+
+val Long.compactFmt: String
+  get() = NumberFormat.getCompactNumberInstance().format(this)
 
 /**
  * Returns a human-readable version of the Byte size, where the input represents a specific number
@@ -31,3 +45,51 @@ fun Long.byteDisplaySize(si: Boolean = true): String {
     }
   }
 }
+
+/** Find the file ends with given [format] under the directory. */
+fun File.findPkg(format: String?) =
+    when (format != null) {
+      true -> walk().firstOrNull { it.isFile && it.name.endsWith(format, ignoreCase = true) }
+      else -> null
+    }
+
+/** List files based on the glob [pattern] */
+fun Path.glob(pattern: String): List<Path> {
+  val matcher = FileSystems.getDefault().getPathMatcher("glob:$pattern")
+  return Files.walk(this).filter(matcher::matches).toList()
+}
+
+/** An extension function to join a multiline string for JVM arguments. */
+fun String.joinToConfigString(separator: CharSequence = "") =
+    trimMargin().lines().joinToString(separator) { it.trim() }
+
+/** System property delegate */
+@Suppress("IMPLICIT_CAST_TO_ANY")
+inline fun <reified T> sysProp(): ReadOnlyProperty<Any?, T> = ReadOnlyProperty { _, property ->
+  val propVal = System.getProperty(property.name, "")
+  val propVals = propVal.split(",", " ").filter { it.isNotBlank() }
+  val kType = typeOf<T>()
+
+  when {
+    // Handle enum values
+    kType.isSubtypeOf(typeOf<Enum<*>?>()) ->
+        T::class.java.enumConstants.filterIsInstance<Enum<*>>().singleOrNull { it.name == propVal }
+
+    // Handle primitive and collection types
+    else ->
+        when (kType) {
+          typeOf<String>() -> propVal
+          typeOf<Int>() -> propVal.toInt()
+          typeOf<Boolean>() -> propVal.toBoolean()
+          typeOf<Long>() -> propVal.toLong()
+          typeOf<Double>() -> propVal.toDouble()
+          typeOf<List<String>>() -> propVals
+          typeOf<List<Int>>() -> propVals.map { it.toInt() }
+          typeOf<List<Long>>() -> propVals.map { it.toLong() }
+          typeOf<List<Double>>() -> propVals.map { it.toDouble() }
+          typeOf<List<Boolean>>() -> propVals.map { it.toBoolean() }
+          else -> error("'${property.name}' system property type ($kType) is not supported!")
+        }
+  }
+      as T
+}

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

@@ -2,6 +2,7 @@ package common
 
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
+import org.gradle.api.artifacts.ExternalDependency
 import org.gradle.api.attributes.Attribute
 import org.gradle.api.tasks.compile.JavaCompile
 import org.gradle.api.tasks.testing.Test
@@ -12,6 +13,7 @@ import org.jetbrains.kotlin.gradle.dsl.*
 import org.jetbrains.kotlin.gradle.plugin.LanguageSettingsBuilder
 import org.jetbrains.kotlin.gradle.targets.js.npm.tasks.KotlinNpmInstallTask
 import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
+import java.nio.file.Path
 
 /** Java version properties. */
 val Project.javaVersion
@@ -195,3 +197,35 @@ context(Project)
 fun KotlinNpmInstallTask.configureKotlinNpm() {
   //args.add("--ignore-engines")
 }
+
+/** Returns the path of the dependency jar in runtime classpath. */
+context(Project)
+val ExternalDependency.dependencyPath get() = configurations
+  .named("runtimeClasspath")
+  .get()
+  .resolvedConfiguration
+  .resolvedArtifacts
+  .find { it.moduleVersion.id.module == module }
+  ?.file
+  ?.path
+  ?: error("Could not find $name in runtime classpath")
+
+/** Returns the application `run` command. */
+context(Project)
+fun Path.appRunCmd(args: List<String>): String {
+  val path = layout.projectDirectory.asFile.toPath().relativize(this)
+  val newLine = System.lineSeparator()
+  val lineCont = """\""" // Bash line continuation
+  val indent = "\t"
+  return args.joinToString(
+    prefix = """
+             |To Run the app,
+             |${'$'} java -jar $lineCont $newLine
+             """.trimMargin(),
+    postfix = "$newLine$indent$path",
+    separator = newLine,
+  ) {
+    // Escape the globstar
+    "$indent$it $lineCont".replace("*", """\*""")
+  }
+}

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

@@ -1,5 +1,6 @@
 package common
 
+import java.io.ByteArrayOutputStream
 import java.nio.file.Path
 import org.gradle.accessors.dm.LibrariesForLibs
 import org.gradle.api.Project
@@ -85,3 +86,48 @@ inline fun <reified T : Task> TaskContainer.maybeRegister(
       in names -> named(taskName, T::class)
       else -> register(taskName, T::class)
     }.also { it.configure(configAction) }
+
+/** Return incubator modules of the tool chain JDK */
+val Project.incubatorModules
+  get(): String {
+    val javaCmd = project.javaToolchainPath.resolve("bin").resolve("java")
+    val bos = ByteArrayOutputStream()
+    val execResult = exec {
+      workingDir = layout.buildDirectory.get().asFile
+      commandLine = listOf(javaCmd.toString())
+      args = listOf("--list-modules")
+      standardOutput = bos
+      errorOutput = bos
+    }
+    execResult.assertNormalExitValue()
+    return bos.toString(Charsets.UTF_8)
+        .lines()
+        .filter { it.startsWith("jdk.incubator") }
+        .joinToString(",") { it.substringBefore("@").trim() }
+  }
+
+/**
+ * Print all the catalog version strings and it's values.
+ *
+ * [VersionCatalogsExtension](https://docs.gradle.org/current/userguide/platforms.html#sub:type-unsafe-access-to-catalog)
+ */
+fun Project.printVersionCatalog() {
+  if (debugEnabled) {
+    catalogs.catalogNames.map { cat ->
+      println("=== Catalog $cat ===")
+      val catalog = catalogs.named(cat)
+      catalog.versionAliases.forEach { alias ->
+        println("${alias.padEnd(30, '-')}-> ${catalog.findVersion(alias).get()}")
+      }
+    }
+  }
+}
+
+/** Print all the tasks */
+fun Project.printTaskGraph() {
+  if (debugEnabled) {
+    gradle.taskGraph.whenReady {
+      allTasks.forEachIndexed { index, task -> println("${index + 1}. ${task.name}") }
+    }
+  }
+}