Friday, September 30, 2022
HomeiOS DevelopmentIntroduction to SPM artifact bundles

Introduction to SPM artifact bundles

XCFrameworks and SPM

Earlier than the introduction of the brand new format we needed to fiddle with FAT binaries to assist a number of platforms. I’ve a deep dive article about frameworks and instruments that you should utilize to assemble a FAT binary, however I now not suggest it since XCFrameworks are right here to remain. 🔨

With a view to construct an XCFramework, it’s a must to use Xcode and a course of could be very easy. You simply have to pick the Framework sort below the iOS tab once you create a brand new mission. Be happy to call it, add your Swift supply code and that is it.

You’ll be able to construct this mission utilizing the command line for a number of platforms by way of the next script.

xcodebuild archive 
  -scheme MySDK 
  -sdk iphoneos 
  -archivePath "construct/ios_devices.xcarchive" 

xcodebuild archive 
  -scheme MySDK 
  -sdk iphonesimulator 
  -archivePath "construct/ios_simulators.xcarchive" 

xcodebuild archive 
  -sdk macosx MACOSX_DEPLOYMENT_TARGET=11.0 
  -arch x86_64 -arch arm64 
  -scheme "MySDK" 
  -archivePath "construct/macos_devices.xcarchive" SKIP_INSTALL=NO

xcodebuild -create-xcframework 
  -framework construct/ios_devices.xcarchive/Merchandise/Library/Frameworks/MySDK.framework 
  -framework construct/ios_simulators.xcarchive/Merchandise/Library/Frameworks/MySDK.framework 
  -framework construct/macos_devices.xcarchive/Merchandise/Library/Frameworks/MySDK.framework 
  -output MySDK.xcframework

You’ll be able to even construct variations for Catalyst and different working programs, if you perform a little search you may simply determine the required parameters and configuration. Lengthy story quick, it’s extremely straightforward to create an xcframework output together with all type of platform slices for particular units. 😊

Now if you wish to use this XCFramework, you may merely drag and drop it to your Xcode mission and it ought to work with out additional points (if it incorporates the mandatory slices). Alternatively you should utilize Swift bundle supervisor and create a binary goal an hook up your exterior framework bundle by way of SPM. That is how a quite simple configuration file seems like.

import PackageDescription

let bundle = Package deal(
    title: "MySDK",
    merchandise: [
        .library(name: "MySDK", targets: ["MySDK"]),
    dependencies: [
    targets: [
        .binaryTarget(name: "MySDK", path: "./MySDK.xcframework")

In your mission you should utilize the library product as an ordinary dependency, and the underlying binary goal will handle importing the mandatory header information and linking the precise library. The one drawback with this strategy is that it’s macOS (or to be much more exact Apple OS solely).

Say hiya to artifact bundles for Swift PM

All proper, so XCFrameworks cannot be used below Linux, however folks like to jot down command line scripts in Swift and use them for server facet tasks. In some instances these scripts (or plugins), wish to name exterior scripts that aren’t put in on the system by default. That is the place artifact bundles may also help, as a result of it makes doable to ship a number of variations of the identical executable binary file. 🤔

Artifact bundles are usually not a alternative for xcframeworks, however extra like an addition, or enchancment because the proposal title signifies this, for the Swift bundle supervisor plugin structure. They permit us to ship precompiled binary information for a number of platforms, this fashion plugin authors do not must compile these instruments from supply and the plugin execution time could be closely lowered.

There’s a nice weblog put up about wrapping the SwiftLint executable in an artifact bundle, so I do not actually need to get into the main points this time, as a result of it is fairly simple. The proposal itself helps loads to grasp the essential setup, additionally the older binary dependencies proposal incorporates some associated data good job Swift crew. 👍

I would like to present an honorable point out to Karim Alweheshy, who’s actively working with the brand new Swift bundle supervisor plugin infrastructure, he has an wonderful repository on GitHub that demos artifact bundles so please have a look you probably have time. 🙏

Anyway, I’ll present you tips on how to wrap an executable into an artifact bundle. Presently there isn’t any strategy to wrap libraries into artifact bundles, that is going to be added afterward.

mkdir MyApp
cd $_
swift bundle init --type=executable

swift construct -c launch

cp $(swift construct --show-bin-path -c launch)/MyApp ./myapp

mkdir MyPluginExample
cd $_
swift bundle init 

mkdir myapp.artifactbundle
cd $_
mkdir myapp-1.0.0-macos
cd $_
mkdir bin

Now the file construction is prepared, we should always create a brand new data.json file below the artifactbundle listing with the next contents. It will describe your bundle with the out there binary variants, you may check out the proposals for the out there triplets variations.

    "schemaVersion": "1.0",
    "artifacts": {
        "myapp": {
            "model": "1.0.0",
            "sort": "executable",
            "variants": [
                    "path": "myapp-1.0.0-macos/bin/myapp",
                    "supportedTriples": ["x86_64-apple-macosx", "arm64-apple-macosx"]

Copy the myapp binary below the myapp-1.0.0-macos/bin/myapp location, and eventually we’ll make a quite simple command plugin to take advangate of this newly added device.

import PackagePlugin
import Basis

struct MyDistCommandPlugin: CommandPlugin {
    func performCommand(context: PluginContext, arguments: [String]) throws {
        let myAppTool = attempt context.device(named: "myapp")
        let myAppToolURL = URL(fileURLWithPath: myAppTool.path.string)

        let course of = attempt Course, arguments: [])
        course of.waitUntilExit()

Watch out with the paths and file names, I used lowercase letters for the whole lot on this instance, I like to recommend to observe this sample once you create your artifact bundle binaries.

swift bundle plugin --list
# ‘hiya’ (plugin ‘HelloCommand’ in bundle ‘MyPluginExample’)
swift bundle hiya
# Howdy, world!

That is it, now we have a working artifact bundle with a customized made executable out there for macOS. We are able to use this artifact bundle as a dependency for a plugin and run the device through the use of the plugin APIs. I would actually love to have the ability to cross compile Swift libraries and executable information afterward, this might make the event / deployment workflow a bit less difficult. Anyway, artifact bundles are a pleasant little addition, I actually like the best way you may ship binaries for a number of platforms and I hope that we’re going to have the ability to share libraries as nicely similarly. 😊



Please enter your comment!
Please enter your name here

Most Popular