Refactor shared versioning (#21)

dev-Fabi · web-flow · commit 8216537f2e70 · 2023-10-08T16:16:59.000+02:00
diff --git a/.github/workflows/checkStyle.yml b/.github/workflows/checkStyle.yml
@@ -1,5 +1,7 @@
 name: Check Style
-
+concurrency: # Cancel currently running style checks when a new one is started
+  group: style-${{ github.ref }}
+  cancel-in-progress: true
 on:
   pull_request:
 
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,67 @@
+name: Publish Shared Swift Package
+concurrency: # Cancel currently running releases when a new one is started
+  group: publish-${{ github.ref_name }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch: # TODO remove
+    branches:
+      - refactor/shared-versioning
+  push:
+    branches:
+      - develop
+      - main
+    paths:
+      - 'androidApp/**'
+      - 'shared/**'
+      - 'buildSrc/**'
+      - 'build.gradle.kts'
+      - 'gradle.properties'
+      - 'settings.gradle.kts'
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      android: ${{ steps.changes.outputs.android }}
+      shared: ${{ steps.changes.outputs.shared }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dorny/paths-filter@v2
+        id: changes
+        with:
+          base: ${{ github.ref }}
+          filters: |
+            android:
+              - 'androidApp/**'
+            shared:
+              - 'shared/**'
+              - 'buildSrc/**'
+              - 'build.gradle.kts'
+              - 'gradle.properties'
+              - 'settings.gradle.kts'
+
+  release-shared:
+    permissions:
+      contents: write
+      packages: write
+    needs: changes
+    if: ${{ needs.changes.outputs.shared == 'true' }}
+    uses: touchlab/KMMBridgeGithubWorkflow/.github/workflows/faktorybuildautoversion.yml@v1.0
+    with:
+      jvmVersion: 17
+      versionBaseProperty: SHARED_BASE_VERSION
+      # kmmBridgePublish = xcFramework, publishAndroidReleasePublicationToGitHubPackagesRepository = Android lib
+      publishTask: kmmBridgePublish publishAndroidReleasePublicationToGitHubPackagesRepository
+    secrets:
+      gradle_params: "-PGITHUB_BRANCH=${{ github.ref_name }}"
+
+
+  android-after-shared:
+    needs: release-shared
+    uses: ./.github/workflows/publishAndroid.yml
+
+  android-only:
+    needs: changes
+    if: ${{ needs.changes.outputs.android == 'true' && needs.changes.outputs.shared == 'false' }}
+    uses: ./.github/workflows/publishAndroid.yml
diff --git a/.github/workflows/publishAndroid.yml b/.github/workflows/publishAndroid.yml
@@ -1,22 +1,13 @@
 name: Publish Android
-concurrency: # Cancel currently running releases when a new one is started
-  group: publish-android-${{ github.ref_name }}
-  cancel-in-progress: true
+
 on:
-  push:
-    branches:
-      - main
-      - develop
-    paths:
-      - 'androidApp/**'
-      - 'shared/**'
-      - 'buildSrc/**'
-      - 'build.gradle.kts'
-      - 'gradle.properties'
-      - 'settings.gradle.kts'
+  workflow_call:
 
 jobs:
-  publish:
+  publish-android:
+    concurrency:
+      group: publish-android-${{ github.ref_name }}
+      cancel-in-progress: true
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -47,13 +38,13 @@ jobs:
 
       - name: Release Android
         if: ${{ github.ref_name == 'main' }}
-        run: ./gradlew publishProdReleaseApps --no-daemon -PkeyPassword=${{ secrets.KEY_PASSWORD }} -PstorePassword=${{ secrets.STORE_PASSWORD }}
+        run: ./gradlew publishProdReleaseApps --no-daemon -PkeyPassword=${{ secrets.KEY_PASSWORD }} -PstorePassword=${{ secrets.STORE_PASSWORD }} -PremoteBuild=true -PGITHUB_PACKAGES_USERNAME=cirunner -PGITHUB_PACKAGES_PASSWORD=${{ secrets.GITHUB_TOKEN }}
         env:
           GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx3g"
 
       - name: Release Android Lava
-        if: ${{ github.ref_name == 'develop' }}
-        run: ./gradlew publishLavaReleaseApps --no-daemon -PkeyPassword=${{ secrets.KEY_PASSWORD }} -PstorePassword=${{ secrets.STORE_PASSWORD }}
+        if: ${{ github.ref_name != 'main' }}
+        run: ./gradlew publishLavaReleaseApps --no-daemon -PkeyPassword=${{ secrets.KEY_PASSWORD }} -PstorePassword=${{ secrets.STORE_PASSWORD }} -PremoteBuild=true -PGITHUB_PACKAGES_USERNAME=cirunner -PGITHUB_PACKAGES_PASSWORD=${{ secrets.GITHUB_TOKEN }}
         env:
           GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx3g"
 
diff --git a/.github/workflows/publishShared.yml b/.github/workflows/publishShared.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,13 +1,12 @@
 name: Test
+concurrency: # Cancel currently running tests when a new one is started
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
 on:
   push:
-    # Push to develop and main branches trigger a release -> tests are run anyway
     branches-ignore:
-      - 'develop'
-      - 'main'
       - 'build-**' # temporary build branch for kmmbridge
 
-
 jobs:
   test:
     runs-on: macos-latest # use mac so that shared iOS targets can also be built
diff --git a/androidApp/build.gradle.kts b/androidApp/build.gradle.kts
@@ -154,8 +154,28 @@ play {
     releaseStatus.set(ReleaseStatus.COMPLETED)
 }
 
+val remoteBuild = project.findProperty("remoteBuild") == "true" // Default false
+if (remoteBuild) {
+    repositories {
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/DatepollSystems/WaiterRobot-Shared-Android")
+            credentials {
+                username = project.property("GITHUB_PACKAGES_USERNAME") as String
+                password = project.property("GITHUB_PACKAGES_PASSWORD") as String
+            }
+        }
+    }
+}
+val SHARED_GROUP: String by project
+val SHARED_BASE_VERSION: String by project
+
 dependencies {
-    implementation(project(":shared"))
+    if (remoteBuild) {
+        implementation("${SHARED_GROUP}:shared-android:${SHARED_BASE_VERSION}.+")
+    } else {
+        implementation(project(":shared"))
+    }
 
     implementation("androidx.lifecycle:lifecycle-process:${Versions.androidxLifecycle}")
     implementation("androidx.lifecycle:lifecycle-runtime-ktx:${Versions.androidxLifecycle}")
diff --git a/androidApp/src/main/AndroidManifest.xml b/androidApp/src/main/AndroidManifest.xml
@@ -1,6 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
+    <uses-feature
+        android:name="android.hardware.camera"
+        android:required="false" />
+
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.CAMERA" />
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -12,6 +12,7 @@ buildscript {
         classpath("com.android.tools.build:gradle:8.1.1")
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")
         classpath("org.jetbrains.kotlin:kotlin-serialization:${kotlinVersion}")
+        classpath("com.codingfeline.buildkonfig:buildkonfig-gradle-plugin:0.14.0")
     }
 }
 
diff --git a/gradle.properties b/gradle.properties
@@ -7,4 +7,7 @@ android.useAndroidX=true
 android.nonTransitiveRClass=true
 #MPP
 kotlin.mpp.enableCInteropCommonization=true
-kotlin.mpp.stability.nowarn=true
+kotlin.mpp.stability.nowarn=true
+
+SHARED_BASE_VERSION=1.1
+SHARED_GROUP=org.datepollsystems.waiterrobot.shared
diff --git a/shared/build.gradle.kts b/shared/build.gradle.kts
@@ -1,36 +1,44 @@
-import co.touchlab.faktory.internal.GithubCalls
-import co.touchlab.faktory.versionmanager.GitTagBasedVersionManager
-import co.touchlab.faktory.versionmanager.GitTagVersionManager
-import co.touchlab.faktory.versionmanager.GithubReleaseVersionWriter
-import co.touchlab.faktory.versionmanager.VersionManager
-import co.touchlab.faktory.versionmanager.VersionWriter
+import com.codingfeline.buildkonfig.compiler.FieldSpec.Type
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
-import java.util.Date
 
 plugins {
     kotlin("multiplatform")
-    kotlin("native.cocoapods")
     kotlin("plugin.serialization")
     id("com.android.library")
-    id("co.touchlab.faktory.kmmbridge") version "0.3.7"
+    id("co.touchlab.kmmbridge") version "0.5.0"
     `maven-publish`
     id("dev.jamiecraane.plugins.kmmresources") version "1.0.0-alpha11" // Shared localization
     id("io.realm.kotlin") version "1.10.2"
+    id("com.codingfeline.buildkonfig")
 }
 
-version = "1.0" // Shared package has only 2 digit version, patch is managed by kmmbridge.
-
-val sharedNamespace = "org.datepollsystems.waiterrobot.shared"
 val generatedLocalizationRoot: String =
     File(project.buildDir, "generated/localizations").absolutePath
 val iosFrameworkName = "shared"
 
+group = project.property("SHARED_GROUP") as String
+version = project.property(
+    if (project.hasProperty("AUTO_VERSION")) "AUTO_VERSION" else "SHARED_BASE_VERSION"
+) as String
+
 kotlin {
-    android()
+    // For some reason androidTarget is recognized by IntelliJ,
+    // but when building it throws "Unresolved reference: androidTarget"
+    // -> Just keep it till it is removed
+    android {
+        publishAllLibraryVariants()
+    }
 
-    iosX64()
-    iosArm64()
-    iosSimulatorArm64()
+    listOf(
+        iosX64(),
+        iosArm64(),
+        iosSimulatorArm64()
+    ).forEach {
+        it.binaries.framework {
+            // Must be set to false for shared localization (otherwise resources are not available)
+            isStatic = false
+        }
+    }
 
     // needed to export kotlin documentation in objective-c headers
     targets.withType<KotlinNativeTarget> {
@@ -120,27 +128,13 @@ kotlin {
         }
     }
 
-    // Needed for kmmbrigde to create swift package
-    cocoapods {
-        name = iosFrameworkName
-        summary = "Shared KMM iOS-module of the WaiterRobot app"
-        homepage = "https://github.com/DatepollSystems/waiterrobot-mobile_android-shared"
-        authors = "DatepollSystems"
-        ios.deploymentTarget = "15"
-
-        framework {
-            // Must be set to false for shared localization (otherwise resources are not available)
-            isStatic = false
-        }
-    }
-
     sourceSets.all {
         languageSettings.optIn("kotlin.RequiresOptIn")
     }
 }
 
 android {
-    namespace = sharedNamespace
+    namespace = group as String
     compileSdk = Versions.androidCompileSdk
     defaultConfig {
         minSdk = Versions.androidMinSdk
@@ -151,25 +145,28 @@ android {
     sourceSets["main"].res.srcDir("$generatedLocalizationRoot/androidMain/res")
 }
 
+addGithubPackagesRepository()
 kmmbridge {
     mavenPublishArtifacts()
-    /** [co.touchlab.faktory.KmmBridgeExtension.githubReleaseVersions] */
-    versionManager.set(CustomGitVersionManager(GitTagVersionManager))
-    versionWriter.set(GithubReleaseVersionWriter(GithubCalls)) // TODO modify to support draft releases, custom title and generation of release notes (for api see https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release)?
     spm()
-    versionPrefix.set(version as String)
 }
-addGithubPackagesRepository()
 
 kmmResourcesConfig {
-    androidApplicationId.set(sharedNamespace) // appId of the shared module
-    packageName.set("${sharedNamespace}.generated.localization")
+    androidApplicationId.set(group as String) // appId of the shared module
+    packageName.set("$group.generated.localization")
     defaultLanguage.set("en")
     input.set(File(project.projectDir, "localization.yml"))
     output.set(project.projectDir)
     srcFolder.set(generatedLocalizationRoot) // place the generated files in the build folder
 }
 
+buildkonfig {
+    packageName = "$group.buildkonfig"
+    defaultConfigs {
+        buildConfigField(Type.STRING, "sharedVersion", version as String, const = true)
+    }
+}
+
 tasks {
     // Plutil generates the localizations for ios
     val plutil = named("executePlutil") {
@@ -210,30 +207,6 @@ tasks {
     }
 }
 
-/**
- * Adds a suffix to the version when a lava/pre release is made
- * see [co.touchlab.faktory.versionmanager.GitTagVersionManager]
- */
-class CustomGitVersionManager(
-    private val manager: GitTagBasedVersionManager
-) : VersionManager by manager {
-    override fun getVersion(
-        project: Project,
-        versionPrefix: String,
-        versionWriter: VersionWriter
-    ): String {
-        val baseVersion = manager.getVersion(project, versionPrefix, versionWriter)
-
-        // Add version suffix for dev releases
-        // e.g. main -> 1.0.1, develop -> 1.0.1-lava-1676142940
-        return when (val branch = project.property("GITHUB_BRANCH")) {
-            "main" -> baseVersion
-            "develop" -> "$baseVersion-lava-${Date().toInstant().epochSecond}"
-            else -> throw IllegalStateException("Unexpected value for property GITHUB_BRANCH: $branch")
-        }
-    }
-}
-
 detekt {
     source.from(
         "src/androidMain/kotlin",
diff --git a/shared/shared.podspec b/shared/shared.podspec

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ buildscript {`
`12`	`12`	`classpath("com.android.tools.build:gradle:8.1.1")`
`13`	`13`	`classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")`
`14`	`14`	`classpath("org.jetbrains.kotlin:kotlin-serialization:${kotlinVersion}")`
	`15`	`+ classpath("com.codingfeline.buildkonfig:buildkonfig-gradle-plugin:0.14.0")`
`15`	`16`	`}`
`16`	`17`	`}`
`17`	`18`