Swift package export setup

Configure your multiplatform project

In the following example, the shared code of a Kotlin Multiplatform project is stored locally in the shared module. If your project is structured differently, substitute "shared" in code and path examples with your module's name.

To set up the publishing of an XCFramework:

1. Update your shared/build.gradle.kts configuration file with the XCFramework call in the iOS targets list:

   import org.jetbrains.kotlin.gradle.plugin.mpp.apple.XCFramework kotlin { // Other Kotlin Multiplatform targets // ... // Name of the module to be imported in the consumer project val xcframeworkName = "Shared" val xcf = XCFramework(xcframeworkName) listOf( iosX64(), iosArm64(), iosSimulatorArm64(), ).forEach { it.binaries.framework { baseName = xcframeworkName // Specify CFBundleIdentifier to uniquely identify the framework binaryOption("bundleId", "org.example.${xcframeworkName}") xcf.add(this) isStatic = true } } //... }

2. Run the Gradle task to create the framework:

   ./gradlew :shared:assembleSharedReleaseXCFramework

   The resulting framework will be created as the shared/build/XCFrameworks/release/Shared.xcframework folder in your project directory.

Prepare the XCFramework and the Swift package manifest

1. Put the Shared.xcframework folder in a ZIP archive and calculate the checksum for the resulting archive, for example:

   swift package compute-checksum Shared.xcframework.zip

2. Upload the ZIP file to the file storage of your choice.

3. Choose any directory and locally create a Package.swift file with the following code:

   // swift-tools-version:5.3 import PackageDescription let package = Package( name: "Shared", platforms: [ .iOS(.v14), ], products: [ .library(name: "Shared", targets: ["Shared"]) ], targets: [ .binaryTarget( name: "Shared", url: "<link to the uploaded XCFramework ZIP file>", checksum:"<checksum calculated for the ZIP file>") ] )

4. In the url field, specify the link to your ZIP archive with the XCFramework.

5. [Optional] If you'd like to validate the resulting manifest, you can run the following shell command in the directory with the Package.swift file:

   swift package reset && swift package show-dependencies --format json

   The output will describe any errors found or show the successful download and parsing result if the manifest is correct.

6. Push the Package.swift file to your remote repository. Make sure to create and push a Git tag with the semantic version of the package.

Add the package dependency

Now that both files are accessible, you can add the package dependency:

1. In Xcode, choose File | Add Package Dependencies.

2. In the search field, enter the URL of the Git repository with the Package.swift file inside:

   

3. Depending on the type of your project, the dialog will vary:

   • If you're making a Swift package, press the Copy package button. This will put a .package line in your clipboard. Paste this line into the Package.Dependency block of your own Package.swift file, and add the necessary product to the appropriate Target.Dependency block.

   • For other Xcode projects, press the Add package button, then select products and corresponding targets for the package.

Check your setup

To check that everything is set up correctly, test the import in Xcode:

1. In your project, navigate to the ContentView.swift file.

2. Replace the code with the following snippet:

   import SwiftUI import Shared struct ContentView: View { var body: some View { VStack { Image(systemName: "globe") .imageScale(.large) .foregroundStyle(.tint) Text("Hello, world! \(Shared.Platform_iosKt.getPlatform().name)") } .padding() } } #Preview { ContentView() }

   Here, you import the Shared XCFramework and then use it to obtain the platform name in the Text field.

3. Ensure that the preview is updated with the new text.