Infrastructure update (#164)

Infrastructure update

Author: Lipen

.github/workflows/build-and-test.yml

@@ -2,9 +2,6 @@ name: Build and run tests
 
 on:
   push:
-    branches:
-      - '*'
-      - '*/*'
   pull_request:
     branches:
       - develop
@@ -16,8 +13,11 @@ permissions:
 
 jobs:
   build:
-    # Skip duplicate build when pushing to already existing PR (in origin repo)
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    # Skip duplicate build when pushing to already existing PR
+    # Note: we decided NOT to skip duplicate builds,
+    #       since we upload test results via 'EnricoMi/publish-unit-test-result-action',
+    #       which requires 'pull_request' trigger for the bot to be able to add a comment to PR.
+    # if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
 
     name: Build on JDK ${{ matrix.jdk }}
 
@@ -46,7 +46,7 @@ jobs:
           cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/develop' }}
 
       - name: Build and run tests
-        run: ./gradlew build --stacktrace
+        run: ./gradlew build --stacktrace --scan
 
       - name: Publish test results
         uses: EnricoMi/publish-unit-test-result-action@v2

.gitignore

@@ -1,5 +1,5 @@
-build
-/.idea
-/.gradle
+.idea/
+.gradle/
+build/
 idea-community
-/*.db
+*.db

build.gradle.kts

@@ -1,54 +1,37 @@
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
-val kotlinVersion: String by rootProject
-val coroutinesVersion: String by rootProject
-val junit5Version: String by project
 val semVer: String? by project
 val includeDokka: String? by project
 
 group = "org.jacodb"
-
-project.version = semVer ?: "1.2-SNAPSHOT"
-
-buildscript {
-    repositories {
-        mavenCentral()
-        maven(url = "https://plugins.gradle.org/m2/")
-    }
-}
+version = semVer ?: "1.2-SNAPSHOT"
 
 plugins {
-    val kotlinVersion = "1.7.21"
-
+    kotlin("jvm") version Versions.kotlin
+    kotlin("plugin.allopen") version Versions.kotlin
+    kotlin("plugin.serialization") version Versions.kotlin apply false
+    with(Plugins.Dokka) { id(id) version (version) }
+    with(Plugins.Licenser) { id(id) version (version) }
     `java-library`
+    `java-test-fixtures`
     `maven-publish`
     signing
-    `java-test-fixtures`
-    kotlin("jvm") version kotlinVersion
-    kotlin("plugin.allopen") version kotlinVersion
-    id("org.jetbrains.dokka") version "1.7.20"
-
-    id("org.cadixdev.licenser") version "0.6.1"
     jacoco
 }
 
-repositories {
-    mavenCentral()
-}
-
 allprojects {
     group = rootProject.group
     version = rootProject.version
 
     apply {
-        plugin("maven-publish")
         plugin("kotlin")
         plugin("org.jetbrains.kotlin.plugin.allopen")
-        plugin("org.cadixdev.licenser")
-        plugin("jacoco")
+        plugin(Plugins.Dokka.id)
+        plugin(Plugins.Licenser.id)
+        plugin("maven-publish")
         plugin("signing")
-        plugin("org.jetbrains.dokka")
+        plugin("jacoco")
     }
 
     repositories {
@@ -60,33 +43,26 @@ allprojects {
     }
 
     dependencies {
-        implementation(group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-core", version = coroutinesVersion)
+        // Kotlin
+        implementation(platform(kotlin("bom")))
+        implementation(kotlin("stdlib-jdk8"))
 
-        implementation(group = "org.jetbrains.kotlin", name = "kotlin-stdlib-jdk8", version = kotlinVersion)
-        implementation(group = "org.jetbrains.kotlin", name = "kotlin-reflect", version = kotlinVersion)
+        // JUnit
+        testImplementation(platform(Libs.junit_bom))
+        testImplementation(Libs.junit_jupiter)
 
-        testImplementation("org.junit.jupiter:junit-jupiter") {
-            version {
-                strictly(junit5Version)
-            }
-        }
-        testImplementation(group = "com.google.guava", name = "guava", version = "31.1-jre")
+        // Test dependencies
+        testRuntimeOnly(Libs.guava)
     }
 
     tasks {
-
-        withType(DokkaTaskPartial::class).configureEach {
-            dokkaSourceSets.configureEach {
-                includes.from("README.md")
-            }
-        }
-
         withType<JavaCompile> {
             sourceCompatibility = "1.8"
             targetCompatibility = "1.8"
             options.encoding = "UTF-8"
             options.compilerArgs = options.compilerArgs + "-Xlint:all"
         }
+
         withType<KotlinCompile> {
             kotlinOptions {
                 jvmTarget = "1.8"
@@ -99,6 +75,7 @@ allprojects {
                 allWarningsAsErrors = false
             }
         }
+
         compileTestKotlin {
             kotlinOptions {
                 jvmTarget = "1.8"
@@ -111,6 +88,15 @@ allprojects {
             }
         }
 
+        withType<Test> {
+            useJUnitPlatform()
+            testLogging {
+                events("passed", "skipped", "failed")
+            }
+            finalizedBy(jacocoTestReport) // report is always generated after tests run
+            jvmArgs = listOf("-Xmx2g", "-XX:+HeapDumpOnOutOfMemoryError", "-XX:HeapDumpPath=heapdump.hprof")
+        }
+
         jacocoTestReport {
             dependsOn(test) // tests are required to run before generating the report
             classDirectories.setFrom(files(classDirectories.files.map {
@@ -124,13 +110,10 @@ allprojects {
             }
         }
 
-        withType<Test> {
-            useJUnitPlatform()
-            jvmArgs = listOf("-Xmx2g", "-XX:+HeapDumpOnOutOfMemoryError", "-XX:HeapDumpPath=heapdump.hprof")
-            testLogging {
-                events("passed", "skipped", "failed")
+        withType<DokkaTaskPartial> {
+            dokkaSourceSets.configureEach {
+                includes.from("README.md")
             }
-            finalizedBy(jacocoTestReport) // report is always generated after tests run
         }
     }
 
@@ -145,7 +128,18 @@ allprojects {
     }
 }
 
-val repoUrl: String? = project.properties["repoUrl"] as? String ?: "https://maven.pkg.github.com/UnitTestBot/jacodb"
+tasks.dokkaHtmlMultiModule {
+    removeChildTasks(
+        listOf(
+            project(":jacodb-examples"),
+            project(":jacodb-cli"),
+            project(":jacodb-benchmarks")
+        )
+    )
+}
+
+val repoUrl: String? = project.properties["repoUrl"] as? String
+    ?: "https://maven.pkg.github.com/UnitTestBot/jacodb"
 
 if (!repoUrl.isNullOrEmpty()) {
     configure(
@@ -207,22 +201,6 @@ if (!repoUrl.isNullOrEmpty()) {
     }
 }
 
-configure(listOf(rootProject)) {
-    tasks {
-        dokkaHtmlMultiModule {
-            removeChildTasks(
-                listOf(
-                    project(":jacodb-examples"),
-                    project(":jacodb-cli"),
-                    project(":jacodb-benchmarks")
-                )
-            )
-        }
-    }
-}
-
-
-
 fun MavenPublication.signPublication(project: Project) = with(project) {
     signing {
         val gpgKey: String? by project
@@ -290,4 +268,9 @@ fun MavenPublication.addPom() {
             }
         }
     }
-}
+}
+
+tasks.wrapper {
+    gradleVersion = "8.3"
+    distributionType = Wrapper.DistributionType.ALL
+}

buildSrc/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    mavenCentral()
+}