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 need to use to assemble a FAT binary, however I not advocate it since XCFrameworks are right here to remain. πŸ”¨

With the intention to construct an XCFramework, you must use Xcode and a course of may be very easy. You simply have to pick out the Framework sort beneath the iOS tab while you create a brand new venture. Be happy to call it, add your Swift supply code and that is it.

You’ll be able to construct this venture utilizing the command line for a number of platforms through 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 possibly can simply work out the required parameters and configuration. Lengthy story quick, it’s extremely simple to create an xcframework output together with all sort of platform slices for particular gadgets. 😊

Now if you wish to use this XCFramework, you possibly can merely drag and drop it to your Xcode venture and it ought to work with out additional points (if it comprises the required slices). Alternatively you need to use Swift package deal supervisor and create a binary goal an hook up your exterior framework bundle through SPM. That is how a quite simple configuration file appears like.

import PackageDescription

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

In your venture you need to use the library product as a typical dependency, and the underlying binary goal will handle importing the required 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 hey to artifact bundles for Swift PM

All proper, so XCFrameworks cannot be used beneath Linux, however individuals like to write down command line scripts in Swift and use them for server aspect initiatives. 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 will help, as a result of it makes potential to ship a number of variations of the identical executable binary file. πŸ€”

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

There’s a nice weblog submit about wrapping the SwiftLint executable in an artifact bundle, so I do not actually need to get into the small print this time, as a result of it is fairly easy. The proposal itself helps so much to grasp the essential setup, additionally the older binary dependencies proposal comprises some associated information good job Swift workforce. πŸ‘

I would like to provide an honorable point out to Karim Alweheshy, who’s actively working with the brand new Swift package deal supervisor plugin infrastructure, he has an wonderful repository on GitHub that demos artifact bundles so please have a look when you’ve got time. πŸ™

Anyway, I will present you how one can wrap an executable into an artifact bundle. At present there is no approach to wrap libraries into artifact bundles, that is going to be added in a while.

mkdir MyApp
cd $_
swift package deal init --type=executable

swift construct -c launch

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

mkdir MyPluginExample
cd $_
swift package deal init 

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

Now the file construction is prepared, we must always create a brand new information.json file beneath the artifactbundle listing with the next contents. This may describe your bundle with the obtainable binary variants, you possibly can check out the proposals for the obtainable 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 beneath the myapp-1.0.0-macos/bin/myapp location, and at last we’ll make a quite simple command plugin to take advangate of this newly added instrument.

import PackagePlugin
import Basis

struct MyDistCommandPlugin: CommandPlugin {
    func performCommand(context: PluginContext, arguments: [String]) throws {
        let myAppTool = attempt context.instrument(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 every part on this instance, I like to recommend to observe this sample while you create your artifact bundle binaries.

swift package deal plugin --list
# β€˜hey’ (plugin β€˜HelloCommand’ in package deal β€˜MyPluginExample’)
swift package deal hey
# Hiya, world!

That is it, now we have got a working artifact bundle with a customized made executable obtainable for macOS. We are able to use this artifact bundle as a dependency for a plugin and run the instrument by utilizing the plugin APIs. I would actually love to have the ability to cross compile Swift libraries and executable information in a while, this might make the event / deployment workflow a bit easier. Anyway, artifact bundles are a pleasant little addition, I actually like the best way you possibly can ship binaries for a number of platforms and I hope that we’re going to have the ability to share libraries as nicely in a similar way. 😊


Please enter your comment!
Please enter your name here