Updating descriptions

touchlab · Dec 19, 2024 · 0afd3bc · 0afd3bc
1 parent 45f5cc9
commit 0afd3bc
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/kmmbridge-github/src/main/kotlin/co/touchlab/kmmbridge/github/KMMBridgeGitHubPlugin.kt b/kmmbridge-github/src/main/kotlin/co/touchlab/kmmbridge/github/KMMBridgeGitHubPlugin.kt
@@ -19,7 +19,7 @@ class KMMBridgeGitHubPlugin : BaseKMMBridgePlugin() {
         if (githubDeploySourceRepo != null && githubDeployTargetRepo != null) {
             project.tasks.register("setupDeployKeys") {
                 group = TASK_GROUP_NAME
-                description = "Helper task to setup GitHub deploy keys"
+                description = "Helper task to setup GitHub deploy keys. Creates an ssh public/private key pair and adds them to the target and source repos."
                 outputs.upToDateWhen { false } // This should always run
 
                 @Suppress("ObjectLiteralToLambda")

diff --git a/kmmbridge/src/main/kotlin/co/touchlab/kmmbridge/KMMBridge.kt b/kmmbridge/src/main/kotlin/co/touchlab/kmmbridge/KMMBridge.kt
@@ -125,6 +125,7 @@ abstract class BaseKMMBridgePlugin : Plugin<Project> {
 
         // Publish task depends on the upload task
         val publishRemoteTask = tasks.register("kmmBridgePublish") {
+            description = "Publishes your framework. Uses your KMMBridge block configured in the build gradle to determine details."
             group = TASK_GROUP_NAME
             dependsOn(uploadTask)
         }

diff --git a/kmmbridge/src/main/kotlin/co/touchlab/kmmbridge/dependencymanager/SpmDependencyManager.kt b/kmmbridge/src/main/kotlin/co/touchlab/kmmbridge/dependencymanager/SpmDependencyManager.kt
@@ -104,7 +104,11 @@ internal class SpmDependencyManager(
                 override fun execute(t: Task) {
                     val checksum = providers.findSpmChecksum(zipFile, projectDir)
                     val url = urlFile.readText()
-                    if (useCustomPackageFile && hasKmmbridgeVariablesSection(swiftPackageFile, packageName)) {
+                    if (useCustomPackageFile && hasKmmbridgeVariablesSection(
+                            swiftPackageFile,
+                            packageName
+                        )
+                    ) {
                         modifyPackageFileVariables(swiftPackageFile, packageName, url, checksum)
                     } else if (useCustomPackageFile) {
                         // We warned you earlier, but you didn't fix it, so now we interrupt the publish process because it's
@@ -160,7 +164,14 @@ internal class SpmDependencyManager(
     ) {
 
         val packageText =
-            makePackageFileText(packageName, url, checksum, perModuleVariablesBlock, swiftToolVersion, platforms)
+            makePackageFileText(
+                packageName,
+                url,
+                checksum,
+                perModuleVariablesBlock,
+                swiftToolVersion,
+                platforms
+            )
         swiftPackageFile.parentFile.mkdirs()
         swiftPackageFile.writeText(packageText)
     }
@@ -199,6 +210,8 @@ internal class SpmDependencyManager(
         val platforms = swiftTargetPlatforms(project)
 
         project.tasks.register("spmDevBuild") {
+            description =
+                "When using SPM, builds a debug version of the XCFramework and writes a local dev path to your Package.swift."
             group = TASK_GROUP_NAME
             dependsOn(project.findXCFrameworkAssembleTask(NativeBuildType.DEBUG))