Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Descriptions #275

Merged
merged 2 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,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)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
}
Expand Down Expand Up @@ -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))

Expand Down