Remove tag trick and cleanup

kpgalligan · kpgalligan · commit ecfdbf709914 · 2024-08-25T16:02:03.000-04:00
diff --git a/gradle.properties b/gradle.properties
@@ -18,7 +18,7 @@ org.gradle.jvmargs=-Xmx4g
 #RELEASE_SIGNING_ENABLED=false
 
 GROUP=co.touchlab.kmmbridge
-VERSION_NAME=1.0.4-SNAPSHOT
+VERSION_NAME=1.0.5-SNAPSHOT
 VERSION_NAME_3x=0.3.7
 
 POM_URL=https://github.com/touchlab/KMMBridge
diff --git a/kmmbridge/src/main/kotlin/BuildFileHelper.kt b/kmmbridge/src/main/kotlin/BuildFileHelper.kt
@@ -11,13 +11,13 @@
  * the License.
  */
 
-import co.touchlab.faktory.internal.githubPublishTokenOrNull
-import co.touchlab.faktory.internal.githubPublishUser
-import co.touchlab.faktory.internal.githubRepoOrNull
+import co.touchlab.faktory.internal.gitLabDomain
 import co.touchlab.faktory.internal.gitLabPublishTokenOrNull
 import co.touchlab.faktory.internal.gitLabPublishUser
 import co.touchlab.faktory.internal.gitLabRepoOrNull
-import co.touchlab.faktory.internal.gitLabDomain
+import co.touchlab.faktory.internal.githubPublishTokenOrNull
+import co.touchlab.faktory.internal.githubPublishUser
+import co.touchlab.faktory.internal.githubRepoOrNull
 import co.touchlab.faktory.publishingExtension
 import org.gradle.api.Project
 import org.gradle.api.credentials.HttpHeaderCredentials
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/KMMBridge.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/KMMBridge.kt
@@ -45,7 +45,7 @@ class KMMBridgePlugin : Plugin<Project> {
         afterEvaluate {
             configureXcFramework()
             configureLocalDev()
-            if(enablePublishing) {
+            if (enablePublishing) {
                 configureArtifactManagerAndDeploy()
             }
         }
@@ -68,7 +68,8 @@ class KMMBridgePlugin : Plugin<Project> {
         val extension = kmmBridgeExtension
         var xcFrameworkConfig: XCFrameworkConfig? = null
 
-        val spmBuildTargets: Set<String> = project.spmBuildTargets?.split(",")?.map { it.trim() }?.filter { it.isNotEmpty() }?.toSet() ?: emptySet()
+        val spmBuildTargets: Set<String> =
+            project.spmBuildTargets?.split(",")?.map { it.trim() }?.filter { it.isNotEmpty() }?.toSet() ?: emptySet()
 
         kotlin.targets
             .withType<KotlinNativeTarget>()
@@ -84,8 +85,9 @@ class KMMBridgePlugin : Plugin<Project> {
                         throw IllegalStateException("Only one framework name currently allowed. Found $currentName and $theName")
                     }
                 }
-                val shouldAddTarget = spmBuildTargets.isEmpty() || spmBuildTargets.contains(framework.target.konanTarget.name)
-                if(shouldAddTarget) {
+                val shouldAddTarget =
+                    spmBuildTargets.isEmpty() || spmBuildTargets.contains(framework.target.konanTarget.name)
+                if (shouldAddTarget) {
                     if (xcFrameworkConfig == null) {
                         xcFrameworkConfig = XCFramework(theName)
                     }
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/KmmBridgeExtension.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/KmmBridgeExtension.kt
@@ -79,7 +79,11 @@ interface KmmBridgeExtension {
      * the name in here.
      */
     @Suppress("unused")
-    fun Project.mavenPublishArtifacts(repository: String? = null, publication: String? = null, artifactSuffix: String? = null) {
+    fun Project.mavenPublishArtifacts(
+        repository: String? = null,
+        publication: String? = null,
+        artifactSuffix: String? = null
+    ) {
         artifactManager.setAndFinalize(MavenPublishArtifactManager(this, publication, artifactSuffix, repository))
     }
 
@@ -99,7 +103,13 @@ interface KmmBridgeExtension {
         swiftToolVersion: String = SwiftToolVersion.Default,
         targetPlatforms: TargetPlatformDsl.() -> Unit = { iOS { v("13") } },
     ) {
-        val dependencyManager = SpmDependencyManager(spmDirectory, useCustomPackageFile, perModuleVariablesBlock, swiftToolVersion, targetPlatforms)
+        val dependencyManager = SpmDependencyManager(
+            spmDirectory,
+            useCustomPackageFile,
+            perModuleVariablesBlock,
+            swiftToolVersion,
+            targetPlatforms
+        )
         dependencyManagers.set(dependencyManagers.getOrElse(emptyList()) + dependencyManager)
         localDevManager.setAndFinalize(dependencyManager)
     }
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/StringExtensions.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/StringExtensions.kt
@@ -1,6 +1,6 @@
 package co.touchlab.faktory
 
-import java.util.Locale
+import java.util.*
 
 fun String.capitalized(): String {
     return this.replaceFirstChar {
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/ArtifactManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/ArtifactManager.kt
@@ -39,5 +39,5 @@ interface ArtifactManager {
     /**
      * Run after file written. This is essentially for GitHub releases.
      */
-    fun finishArtifact(project: Project, version: String, dependencyManagers:List<DependencyManager>) {}
+    fun finishArtifact(project: Project, version: String, dependencyManagers: List<DependencyManager>) {}
 }
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/GithubReleaseArtifactManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/GithubReleaseArtifactManager.kt
@@ -1,16 +1,11 @@
 package co.touchlab.faktory.artifactmanager
 
-import co.touchlab.faktory.dependencymanager.DependencyManager
-import co.touchlab.faktory.dependencymanager.SpmDependencyManager
 import co.touchlab.faktory.internal.GithubCalls
 import co.touchlab.faktory.internal.githubRepo
-import co.touchlab.faktory.internal.procRunFailLog
-import co.touchlab.faktory.internal.skipGitHumReleaseSpmChecks
 import co.touchlab.faktory.kmmBridgeExtension
 import org.gradle.api.GradleException
 import org.gradle.api.Project
 import java.io.File
-import java.util.*
 
 class GithubReleaseArtifactManager(
     private val repository: String?, private val releaseString: String?, private val useExistingRelease: Boolean
@@ -36,86 +31,6 @@ class GithubReleaseArtifactManager(
         val uploadUrl = GithubCalls.uploadZipFile(project, zipFilePath, repoName, idReply, fileName)
         return "${uploadUrl}.zip"
     }
-
-    override fun finishArtifact(project: Project, version: String, dependencyManagers: List<DependencyManager>) {
-        val needsSpmReleaseTagUpdate = dependencyManagers.any { it is SpmDependencyManager }
-        if (needsSpmReleaseTagUpdate) {
-
-            val gitCommonDir = project.procRunFailLog("git", "rev-parse", "--git-common-dir").first().trim()
-            project.logger.warn("gitCommonDir: $gitCommonDir")
-            val trimmedPath = gitCommonDir.substring(0, gitCommonDir.length - ".git".length)
-            val repoHomeDir = if (trimmedPath.isEmpty()) {
-                null
-            } else {
-                File(trimmedPath)
-            }
-
-            project.logger.warn("Running git diff")
-            val diffResult = project.procRunFailLog("git", "diff", "--name-only", dir = repoHomeDir)
-
-            val skipCheck = project.skipGitHumReleaseSpmChecks
-            if (!skipCheck) {
-                // We *usually* expect one file in the diff, which is the Package.swift file. However, if the repo does
-                // not already have a local-dev Package.swift file being tracked, git diff doesn't see the new file.
-                // To be extra safe, at some point we should check that the Package.swift file was actually written,
-                // but this should at least help pinpoint issues from GitHub Actions logs.
-                val expectedResult = diffResult.size == 1 && diffResult.first().contains("Package.swift")
-                if (!expectedResult) {
-                    project.logger.warn("Normally we'd expect a single Package.swift in the git diff. If you do not have Package.swift in your main branch, ignore this warning.")
-
-                    if (diffResult.size > 1) {
-                        project.logger.error("Failing spm check. To disable this check add SKIP_GITHUB_RELEASE_SPM_CHECKS=true to your Gradle properties or pass the Gradle property in on the command line.")
-                        throw GradleException(
-                            "git diff should be one file. Multiple found: ${
-                                diffResult.joinToString(
-                                    "\n"
-                                ) { " --|$it" }
-                            }"
-                        )
-                    }
-                }
-            }
-
-            val tempBranch = UUID.randomUUID().toString()
-
-            // Get the tag created by the GitHub release
-            project.logger.warn("Running git fetch")
-            project.procRunFailLog("git", "fetch", "--tags", dir = repoHomeDir)
-
-
-            // Create a local branch. We don't need to delete is as we just need the commit ref.
-            project.logger.warn("Running git checkout new branch")
-            project.procRunFailLog("git", "checkout", "-b", tempBranch, dir = repoHomeDir)
-
-            // Add and commit
-            project.logger.warn("Running git add")
-            project.procRunFailLog("git", "add", ".", dir = repoHomeDir)
-
-            project.logger.warn("Running git commit")
-            project.procRunFailLog("git", "commit", "-m", "KMP SPM package release for $version", dir = repoHomeDir)
-
-            // Force-update the tag created by the GitHub release
-            project.logger.warn("Running git tag")
-            project.procRunFailLog(
-                "git",
-                "tag",
-                "-fa",
-                version,
-                "-m",
-                "KMP release version $version", dir = repoHomeDir
-            )
-
-            // Force-push the tag reference. This will push the tag and commit.
-            project.logger.warn("Running git push")
-            project.procRunFailLog(
-                "git",
-                "push",
-                "origin",
-                "-f",
-                "refs/tags/${version}", dir = repoHomeDir
-            )
-        }
-    }
 }
 
 private fun artifactName(project: Project, versionString: String, useExistingRelease: Boolean): String {
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/MavenPublishArtifactManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/artifactmanager/MavenPublishArtifactManager.kt
@@ -22,7 +22,7 @@ class MavenPublishArtifactManager(
     private val publicationName: String?,
     artifactSuffix: String?,
     private val repositoryName: String?,
-    ) : ArtifactManager {
+) : ArtifactManager {
     private val group: String = project.group.toString().replace(".", "/")
     private val kmmbridgeArtifactId = "${project.name}-${artifactSuffix ?: KMMBRIDGE_ARTIFACT_SUFFIX}"
 
@@ -32,7 +32,10 @@ class MavenPublishArtifactManager(
         uploadTask: TaskProvider<Task>,
         kmmPublishTask: TaskProvider<Task>
     ) {
-        project.publishingExtension.publications.create(publicationName ?: FRAMEWORK_PUBLICATION_NAME, MavenPublication::class.java) {
+        project.publishingExtension.publications.create(
+            publicationName ?: FRAMEWORK_PUBLICATION_NAME,
+            MavenPublication::class.java
+        ) {
             this.version = version
             val archiveProvider = project.tasks.named("zipXCFramework", Zip::class.java).flatMap {
                 it.archiveFile
@@ -54,8 +57,7 @@ class MavenPublishArtifactManager(
                     dependsOn(kmmPublishTask)
                 }
             }
-        }
-        catch(_: UnknownTaskException) {
+        } catch (_: UnknownTaskException) {
             project.logger.warn("Gradle publish task not found")
         }
     }
@@ -98,18 +100,20 @@ class MavenPublishArtifactManager(
         repositoryName?.let {
             publishingExtension.repositories.findByName(it) as MavenArtifactRepository
         } ?: publishingExtension.repositories.filterIsInstance<MavenArtifactRepository>().firstOrNull()
-        ?: throw GradleException("Artifact repository not found, please, specify maven repository\n" +
-                "publishing {\n" +
-                "    repositories {\n" +
-                "        maven {\n" +
-                "            url = uri(\"https://someservice/path/to/repo\")\n" +
-                "            credentials {\n" +
-                "                username = publishUsername\n" +
-                "                password = publishPassword\n" +
-                "            }\n" +
-                "        }\n" +
-                "    }\n" +
-                "}")
+        ?: throw GradleException(
+            "Artifact repository not found, please, specify maven repository\n" +
+                    "publishing {\n" +
+                    "    repositories {\n" +
+                    "        maven {\n" +
+                    "            url = uri(\"https://someservice/path/to/repo\")\n" +
+                    "            credentials {\n" +
+                    "                username = publishUsername\n" +
+                    "                password = publishPassword\n" +
+                    "            }\n" +
+                    "        }\n" +
+                    "    }\n" +
+                    "}"
+        )
 
     private fun artifactPath(url: String, version: String) =
         "$url/$group/$kmmbridgeArtifactId/$version/$kmmbridgeArtifactId-$version.zip"
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/dependencymanager/CocoapodsDependencyManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/dependencymanager/CocoapodsDependencyManager.kt
@@ -13,9 +13,13 @@
 
 package co.touchlab.faktory.dependencymanager
 
-import co.touchlab.faktory.*
+import co.touchlab.faktory.TASK_GROUP_NAME
+import co.touchlab.faktory.cocoapods
 import co.touchlab.faktory.internal.procRunFailLog
+import co.touchlab.faktory.kmmBridgeExtension
 import co.touchlab.faktory.kotlin
+import co.touchlab.faktory.layoutBuildDir
+import co.touchlab.faktory.urlFile
 import org.gradle.api.Action
 import org.gradle.api.Project
 import org.gradle.api.Task
@@ -58,7 +62,7 @@ class CocoapodsDependencyManager(
             dependsOn(generatePodspecTask)
 
             @Suppress("ObjectLiteralToLambda")
-            doLast(object : Action<Task>{
+            doLast(object : Action<Task> {
                 override fun execute(t: Task) {
                     val extras = mutableListOf<String>()
 
@@ -73,8 +77,16 @@ class CocoapodsDependencyManager(
                     when (val specRepo = specRepoDeferred()) {
                         is SpecRepo.Trunk ->
                             project.procRunFailLog("pod", "trunk", "push", podSpecFile, *extras.toTypedArray())
+
                         is SpecRepo.Private ->
-                            project.procRunFailLog("pod", "repo", "push", specRepo.url, podSpecFile, *extras.toTypedArray())
+                            project.procRunFailLog(
+                                "pod",
+                                "repo",
+                                "push",
+                                specRepo.url,
+                                podSpecFile,
+                                *extras.toTypedArray()
+                            )
                     }
                 }
             })
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/dependencymanager/SpmDependencyManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/dependencymanager/SpmDependencyManager.kt
@@ -37,7 +37,7 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
 import java.io.ByteArrayOutputStream
 import java.io.File
 import java.nio.charset.Charset
-import java.util.Locale
+import java.util.*
 
 class SpmDependencyManager(
     /**
@@ -139,7 +139,8 @@ class SpmDependencyManager(
         platforms: String
     ) {
         val swiftPackageFile = file(swiftPackageFilePath())
-        val packageText = makePackageFileText(packageName, url, checksum, perModuleVariablesBlock, swiftToolVersion, platforms)
+        val packageText =
+            makePackageFileText(packageName, url, checksum, perModuleVariablesBlock, swiftToolVersion, platforms)
         swiftPackageFile.parentFile.mkdirs()
         swiftPackageFile.writeText(packageText)
     }
@@ -189,7 +190,7 @@ class SpmDependencyManager(
             doLast(object : Action<Task> {
                 override fun execute(t: Task) {
                     val swiftToolVersion = SwiftToolVersion.of(_swiftToolVersion)
-                                           ?: throw IllegalArgumentException("Parameter swiftToolVersion should be not blank!")
+                        ?: throw IllegalArgumentException("Parameter swiftToolVersion should be not blank!")
 
                     val targetPlatforms = TargetPlatformDsl().apply(_targetPlatforms)
                         .targetPlatforms
@@ -213,17 +214,18 @@ class SpmDependencyManager(
         }
     }
 
-    private fun platforms(project: Project, targetPlatforms: List<TargetPlatform>): String = targetPlatforms.flatMap { platform ->
-        project.kotlin.targets
-            .withType<KotlinNativeTarget>()
-            .asSequence()
-            .filter { it.konanTarget.family.isAppleFamily }
-            .filter { appleTarget -> platform.targets.firstOrNull { it.konanTarget == appleTarget.konanTarget } != null }
-            .mapNotNull { it.konanTarget.family.swiftPackagePlatformName }
-            .distinct()
-            .map { platformName -> ".$platformName(.v${platform.version.name})" }
-            .toList()
-    }.joinToString(separator = ",\n")
+    private fun platforms(project: Project, targetPlatforms: List<TargetPlatform>): String =
+        targetPlatforms.flatMap { platform ->
+            project.kotlin.targets
+                .withType<KotlinNativeTarget>()
+                .asSequence()
+                .filter { it.konanTarget.family.isAppleFamily }
+                .filter { appleTarget -> platform.targets.firstOrNull { it.konanTarget == appleTarget.konanTarget } != null }
+                .mapNotNull { it.konanTarget.family.swiftPackagePlatformName }
+                .distinct()
+                .map { platformName -> ".$platformName(.v${platform.version.name})" }
+                .toList()
+        }.joinToString(separator = ",\n")
 }
 
 internal fun stripEndSlash(path: String): String {
diff --git a/kmmbridge/src/main/kotlin/co/touchlab/faktory/internal/GithubCalls.kt b/kmmbridge/src/main/kotlin/co/touchlab/faktory/internal/GithubCalls.kt
@@ -45,7 +45,7 @@ object GithubCalls {
         return gson.fromJson(okHttpClient.newCall(createRequest).execute().body!!.string(), IdReply::class.java).id
     }
 
-    fun uploadZipFile(project: Project, zipFilePath: File, repo:String, releaseId: Int, fileName: String):String{
+    fun uploadZipFile(project: Project, zipFilePath: File, repo: String, releaseId: Int, fileName: String): String {
         val gson = Gson()
         val token = project.githubPublishToken
         val body: RequestBody = zipFilePath.asRequestBody("application/zip".toMediaTypeOrNull())
@@ -67,9 +67,11 @@ object GithubCalls {
         return gson.fromJson(uploadResponseString, UploadReply::class.java).url
     }
 
-    fun findReleaseId(project: Project,
-                      repoName: String,
-                      artifactReleaseTag: String): Int?{
+    fun findReleaseId(
+        project: Project,
+        repoName: String,
+        artifactReleaseTag: String
+    ): Int? {
         val token = project.githubPublishToken
         val request: Request =
             Request.Builder().url("https://api.github.com/repos/${repoName}/releases/tags/${artifactReleaseTag}").get()
diff --git a/kmmbridge/src/test/kotlin/co/touchlab/faktory/internal/VersionNumberHelperTest.kt b/kmmbridge/src/test/kotlin/co/touchlab/faktory/internal/VersionNumberHelperTest.kt

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class KMMBridgePlugin : Plugin<Project> {`
`45`	`45`	`afterEvaluate {`
`46`	`46`	`configureXcFramework()`
`47`	`47`	`configureLocalDev()`
`48`		`- if(enablePublishing) {`
	`48`	`+ if (enablePublishing) {`
`49`	`49`	`configureArtifactManagerAndDeploy()`
`50`	`50`	`}`
`51`	`51`	`}`
`@@ -68,7 +68,8 @@ class KMMBridgePlugin : Plugin<Project> {`
`68`	`68`	`val extension = kmmBridgeExtension`
`69`	`69`	`var xcFrameworkConfig: XCFrameworkConfig? = null`
`70`	`70`
`71`		`- val spmBuildTargets: Set<String> = project.spmBuildTargets?.split(",")?.map { it.trim() }?.filter { it.isNotEmpty() }?.toSet() ?: emptySet()`
	`71`	`+ val spmBuildTargets: Set<String> =`
	`72`	`+ project.spmBuildTargets?.split(",")?.map { it.trim() }?.filter { it.isNotEmpty() }?.toSet() ?: emptySet()`
`72`	`73`
`73`	`74`	`kotlin.targets`
`74`	`75`	`.withType<KotlinNativeTarget>()`
`@@ -84,8 +85,9 @@ class KMMBridgePlugin : Plugin<Project> {`
`84`	`85`	`throw IllegalStateException("Only one framework name currently allowed. Found $currentName and $theName")`
`85`	`86`	`}`
`86`	`87`	`}`
`87`		`- val shouldAddTarget = spmBuildTargets.isEmpty() \|\| spmBuildTargets.contains(framework.target.konanTarget.name)`
`88`		`- if(shouldAddTarget) {`
	`88`	`+ val shouldAddTarget =`
	`89`	`+ spmBuildTargets.isEmpty() \|\| spmBuildTargets.contains(framework.target.konanTarget.name)`
	`90`	`+ if (shouldAddTarget) {`
`89`	`91`	`if (xcFrameworkConfig == null) {`
`90`	`92`	`xcFrameworkConfig = XCFramework(theName)`
`91`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,5 @@ interface ArtifactManager {`
`39`	`39`	`/**`
`40`	`40`	`* Run after file written. This is essentially for GitHub releases.`
`41`	`41`	`*/`
`42`		`- fun finishArtifact(project: Project, version: String, dependencyManagers:List<DependencyManager>) {}`
	`42`	`+ fun finishArtifact(project: Project, version: String, dependencyManagers: List<DependencyManager>) {}`
`43`	`43`	`}`