Merge branch 'main' into feature/add-changelog

.github/workflows/d4l-ci-latest-version.yml

@@ -9,11 +9,13 @@ on:
 jobs:
   latest-version:
 
-    runs-on: [self-hosted, macos]
+    runs-on: macos-latest
 
     env:
-      PACKAGE_REGISTRY_USERNAME: ${{ secrets.PACKAGE_REGISTRY_USERNAME }}
-      PACKAGE_REGISTRY_TOKEN: ${{ secrets.PACKAGE_REGISTRY_TOKEN }}
+      PACKAGE_REGISTRY_DOWNLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_USERNAME }}
+      PACKAGE_REGISTRY_DOWNLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_TOKEN }}
+      PACKAGE_REGISTRY_UPLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_USERNAME }}
+      PACKAGE_REGISTRY_UPLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_TOKEN }}
 
     steps:
       - name: Display runner context

.github/workflows/d4l-ci-publish-release.yml

@@ -8,11 +8,13 @@ on:
 jobs:
   publish-release:
 
-    runs-on: [self-hosted, macos]
+    runs-on: macos-latest
 
     env:
-      PACKAGE_REGISTRY_USERNAME: ${{ secrets.PACKAGE_REGISTRY_USERNAME }}
-      PACKAGE_REGISTRY_TOKEN: ${{ secrets.PACKAGE_REGISTRY_TOKEN }}
+      PACKAGE_REGISTRY_DOWNLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_USERNAME }}
+      PACKAGE_REGISTRY_DOWNLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_TOKEN }}
+      PACKAGE_REGISTRY_UPLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_USERNAME }}
+      PACKAGE_REGISTRY_UPLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_TOKEN }}
 
     steps:
       - name: Display runner context

.github/workflows/d4l-ci-pull-request-validation.yml

@@ -10,11 +10,17 @@ on:
 jobs:
   pull-request-validation:
 
-    runs-on: [self-hosted, macos]
+    runs-on: macos-latest
+
+    concurrency:
+      group: validation-${{ github.head_ref }}
+      cancel-in-progress: true
 
     env:
-      PACKAGE_REGISTRY_USERNAME: ${{ secrets.PACKAGE_REGISTRY_USERNAME }}
-      PACKAGE_REGISTRY_TOKEN: ${{ secrets.PACKAGE_REGISTRY_TOKEN }}
+      PACKAGE_REGISTRY_DOWNLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_USERNAME }}
+      PACKAGE_REGISTRY_DOWNLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_DOWNLOAD_TOKEN }}
+      PACKAGE_REGISTRY_UPLOAD_USERNAME: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_USERNAME }}
+      PACKAGE_REGISTRY_UPLOAD_TOKEN: ${{ secrets.PACKAGE_REGISTRY_UPLOAD_TOKEN }}
 
     steps:
       - name: Display runner context

.gitignore

@@ -1,5 +1,6 @@
 # Gradle
 .gradle/
+.gradle/*
 build/
 out/
 local.properties
@@ -16,7 +17,6 @@ local.properties
 !.idea/codeStyles/
 !.idea/encoding.xml
 !.idea/copyright/
-!.idea/compiler.xml
 
 # generated
 

README.adoc

@@ -1,5 +1,5 @@
-= Data4Life Result Util SDK
-:result-util-sdk-version: 0.1.0
+= Data4Life Result SDK
+:result-sdk-version: 0.1.0
 :doctype: article
 :!showtitle:
 :toc: macro

build.gradle.kts

@@ -13,22 +13,17 @@
  * applications and/or if you’d like to contribute to the development of the SDK, please
  * contact D4L by email to [email protected].
  */
-
-buildscript {
-    dependencies {
-        classpath(GradlePlugins.kotlin)
-        classpath(GradlePlugins.android)
-    }
-}
+import care.data4life.sdk.result.dependency.d4l
+import care.data4life.sdk.result.dependency.gitHub
 
 plugins {
-    kotlinMultiplatform(false)
+    id("care.data4life.sdk.result.dependency")
 
-    id("scripts.dependency-updates")
-    id("scripts.download-scripts")
-    id("scripts.publishing")
-    id("scripts.quality-spotless")
-    id("scripts.versioning")
+    id("care.data4life.sdk.result.dependency-updates")
+    id("care.data4life.sdk.result.download-scripts")
+    id("care.data4life.sdk.result.publishing")
+    id("care.data4life.sdk.result.quality-spotless")
+    id("care.data4life.sdk.result.versioning")
 }
 
 allprojects {
@@ -43,6 +38,6 @@ allprojects {
 }
 
 tasks.named<Wrapper>("wrapper") {
-    gradleVersion = "6.8.3"
+    gradleVersion = "6.9"
     distributionType = Wrapper.DistributionType.ALL
 }

buildSrc/build.gradle.kts

@@ -16,14 +16,20 @@
 
 plugins {
     `kotlin-dsl`
+
+    id("care.data4life.sdk.result.dependency")
 }
 
 repositories {
     gradlePluginPortal()
     mavenCentral()
+    google()
 }
 
 dependencies {
+    implementation(care.data4life.sdk.result.dependency.GradlePlugin.kotlin)
+    implementation(care.data4life.sdk.result.dependency.GradlePlugin.android)
+
     // dependency-updates
     implementation("com.github.ben-manes:gradle-versions-plugin:0.38.0")
     // download-scripts

buildSrc/src/main/kotlin/LibraryConfig.kt → buildSrc/src/main/kotlin/care/data4life/sdk/result/LibraryConfig.kt

@@ -13,22 +13,23 @@
  * applications and/or if you’d like to contribute to the development of the SDK, please
  * contact D4L by email to [email protected].
  */
+package care.data4life.sdk.result
 
 object LibraryConfig {
+    val publishConfig = PublishConfig
+    val android = AndroidLibraryConfig
+
     const val group = "care.data4life"
     const val name = "hc-result-sdk-kmp"
 
     const val githubOwner = "d4l-data4life"
     const val githubRepository = "hc-result-sdk-kmp"
 
-    val publish = PublishConfig
-
     object PublishConfig {
-        const val name = LibraryConfig.name
+        const val groupId = "care.data4life.hc-result-sdk-kmp"
         const val description = "This is the Result SDK which provides unified result types and errors for other SDK's."
-        const val groupId = "${LibraryConfig.group}.${LibraryConfig.name}"
 
-        const val year = "2020"
+        const val year = "2021"
 
         // URL
         const val host = "github.com"
@@ -52,8 +53,6 @@ object LibraryConfig {
         const val scmDeveloperConnection = scmConnection
     }
 
-    val android = AndroidLibraryConfig
-
     object AndroidLibraryConfig {
         const val minSdkVersion = 23
         const val compileSdkVersion = 30

buildSrc/src/main/kotlin/scripts/dependency-updates.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/dependency-updates.gradle.kts

@@ -14,7 +14,7 @@
  * contact D4L by email to [email protected].
  */
 
-package scripts
+package care.data4life.sdk.result
 
 /**
  * [DependencyUpdates](https://github.com/ben-manes/gradle-versions-plugin)

buildSrc/src/main/kotlin/scripts/download-scripts.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/download-scripts.gradle.kts

@@ -14,7 +14,7 @@
  * contact D4L by email to [email protected].
  */
 
-package scripts
+package care.data4life.sdk.result
 
 import de.undercouch.gradle.tasks.download.Download
 

buildSrc/src/main/kotlin/scripts/publishing-config.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/publishing-config.gradle.kts

@@ -14,26 +14,27 @@
  * contact D4L by email to [email protected].
  */
 
-package scripts
+package care.data4life.sdk.result
 
-import LibraryConfig
 import org.gradle.api.publish.maven.MavenPublication
 
 /**
- * Usage:
+ * Install:
  *
- * Now just add id("scripts.publishing-config") to your projects build.gradle.kts plugins section
+ * Just add id("care.data4life.sdk.result.publishing-config") to your project module build.gradle.kts plugins section
  *
  * plugins {
- *     id("scripts.publishing")
+ *     id("care.data4life.sdk.result.publishing-config")
  * }
  *
+ * Usage:
+ *
  * To publish to to https://github.com/d4l-data4life/maven-repository/ just run:
  * - ./gradlew publishFeature
  * - ./gradlew publishSnapshot
  * - ./gradlew publishRelease
  *
- * This requires a LibraryConfig as defined here https://github.com/d4l-data4life/hc-gradle-scripts/blob/main/buildSrc/src/main/kotlin/LibraryConfig.kt
+ * This requires a care.data4life.sdk.result.care.data4life.sdk.result.LibraryConfig configured
  */
 plugins {
     `maven-publish`
@@ -46,9 +47,9 @@ publishing {
             setUrl("https://maven.pkg.github.com/${LibraryConfig.githubOwner}/${LibraryConfig.githubRepository}")
             credentials {
                 username = (project.findProperty("gpr.user")
-                    ?: System.getenv("PACKAGE_REGISTRY_USERNAME")).toString()
+                    ?: System.getenv("PACKAGE_REGISTRY_UPLOAD_USERNAME")).toString()
                 password = (project.findProperty("gpr.key")
-                    ?: System.getenv("PACKAGE_REGISTRY_TOKEN")).toString()
+                    ?: System.getenv("PACKAGE_REGISTRY_UPLOAD_TOKEN")).toString()
             }
         }
 
@@ -72,34 +73,33 @@ publishing {
 
     publications {
         withType<MavenPublication> {
-            groupId = LibraryConfig.publish.groupId
+            groupId = LibraryConfig.PublishConfig.groupId
 
             pom {
-                name.set(LibraryConfig.publish.name)
-                description.set(LibraryConfig.publish.description)
-                url.set(LibraryConfig.publish.url)
-                inceptionYear.set(LibraryConfig.publish.year)
+                description.set(LibraryConfig.PublishConfig.description)
+                url.set(LibraryConfig.PublishConfig.url)
+                inceptionYear.set(LibraryConfig.PublishConfig.year)
 
                 licenses {
                     license {
-                        name.set(LibraryConfig.publish.licenseName)
-                        url.set(LibraryConfig.publish.licenseUrl)
-                        distribution.set(LibraryConfig.publish.licenseDistribution)
+                        name.set(LibraryConfig.PublishConfig.licenseName)
+                        url.set(LibraryConfig.PublishConfig.licenseUrl)
+                        distribution.set(LibraryConfig.PublishConfig.licenseDistribution)
                     }
                 }
 
                 developers {
                     developer {
-                        id.set(LibraryConfig.publish.developerId)
-                        name.set(LibraryConfig.publish.developerName)
-                        email.set(LibraryConfig.publish.developerEmail)
+                        id.set(LibraryConfig.PublishConfig.developerId)
+                        name.set(LibraryConfig.PublishConfig.developerName)
+                        email.set(LibraryConfig.PublishConfig.developerEmail)
                     }
                 }
 
                 scm {
-                    connection.set(LibraryConfig.publish.scmConnection)
-                    developerConnection.set(LibraryConfig.publish.scmDeveloperConnection)
-                    url.set(LibraryConfig.publish.scmUrl)
+                    connection.set(LibraryConfig.PublishConfig.scmConnection)
+                    developerConnection.set(LibraryConfig.PublishConfig.scmDeveloperConnection)
+                    url.set(LibraryConfig.PublishConfig.scmUrl)
                 }
             }
         }

buildSrc/src/main/kotlin/scripts/publishing.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/publishing.gradle.kts

@@ -14,17 +14,18 @@
  * contact D4L by email to [email protected].
  */
 
-package scripts
+package care.data4life.sdk.result
 
-import LibraryConfig
 import org.eclipse.jgit.api.Git
 import org.eclipse.jgit.api.ResetCommand
 import org.eclipse.jgit.transport.PushResult
 import org.eclipse.jgit.transport.RemoteRefUpdate
 import org.eclipse.jgit.transport.UsernamePasswordCredentialsProvider
 
 /**
- * Usage:
+ * Publish generated artefacts to our maven-repository using [jGit](https://www.eclipse.org/jgit/)
+ *
+ * Install:
  *
  * You need to add following dependencies to the buildSrc/build.gradle.kts
  *
@@ -38,12 +39,14 @@ import org.eclipse.jgit.transport.UsernamePasswordCredentialsProvider
  *     mavenCentral()
  * }
  *
- * Now just add id("scripts.publishing") to your rootProject build.gradle.kts plugins
+ * Now just add id("care.data4life.sdk.result.publishing") to your rootProject build.gradle.kts plugins
  *
  * plugins {
- *     id("scripts.publishing")
+ *     id("care.data4life.sdk.result.publishing")
  * }
  *
+ * Usage:
+ *
  * To publish to to https://github.com/d4l-data4life/maven-features/ just run:
  * - ./gradlew publishFeature
  * To publish to to https://github.com/d4l-data4life/maven-snapshots/ just run:
@@ -63,7 +66,7 @@ val releaseRepoName = "maven-releases"
 val basePath = "${rootProject.buildDir}/gitPublish"
 
 val gitHubToken = (project.findProperty("gpr.key")
-    ?: System.getenv("PACKAGE_REGISTRY_TOKEN")).toString()
+    ?: System.getenv("PACKAGE_REGISTRY_UPLOAD_TOKEN")).toString()
 
 
 task<Exec>("publishFeature") {

buildSrc/src/main/kotlin/scripts/quality-spotless.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/quality-spotless.gradle.kts

@@ -14,7 +14,7 @@
  * contact D4L by email to [email protected].
  */
 
-package scripts
+package care.data4life.sdk.result
 
 /**
  * You need to add following dependencies to the buildSrc/build.gradle.kts

buildSrc/src/main/kotlin/scripts/versioning.gradle.kts → buildSrc/src/main/kotlin/care/data4life/sdk/result/versioning.gradle.kts

@@ -13,7 +13,7 @@
  * applications and/or if you’d like to contribute to the development of the SDK, please
  * contact D4L by email to [email protected].
  */
-package scripts
+package care.data4life.sdk.result
 
 /**
  * Usage: