重要提示

此项目已不再维护。建议您使用像 segment-integrations/swift-create-xcframework 这样的分支，它包含了对 Xcode 15 的支持。

swift-create-xcframework 是一个非常简单的工具，旨在封装 xcodebuild 以及为 Swift 包创建多个框架并将它们合并到一个单独的 XCFramework 中的过程。

在 2020 年 6 月 23 日，Apple 发布了 Xcode 12 和 Swift 5.3，并支持二进制目标。虽然它们提供了一种简化的方式来在您的包中包含二进制框架，但它们没有提供一种简单的方式来创建您的 XCFramework，只有一些关于漫长手动过程的文档。 swift-create-xcframework 弥合了这一差距。

注意： swift-create-xcframework 早于 WWDC20 公告，并在 Xcode 11.4 或更高版本中进行了测试，但应该适用于 Xcode 11.2 或更高版本。即使没有 Xcode 12，您也可以手动将生成的 XCFramework 包含在您的应用程序中。

swift create-xcframework

默认情况下，swift-create-xcframework 将为您的 Package.swift 中的所有 library 产品或您在命令行上指定的任何目标构建 XCFramework（这也可以用于您包含的任何依赖项）。

var package = Package(
    name: "example-generator",
    platforms: [
	    .ios(.v12),
    	 .macos(.v10_12)
    ],
    products: [
        .library(
            name: "ExampleGenerator",
            targets: [ "ExampleGenerator" ]),
    ],
    dependencies: [],
    targets: [
		...
	]
)

默认情况下，swift-create-xcframework 将构建支持以下平台的 ExampleGenerator.xcframework：macosx、iphoneos、iphonesimulator。额外的 .library 产品也将自动构建。

您可以缩小构建范围。如果您省略平台规范，我们将为所有支持 Swift 二进制框架的平台构建，在撰写本文时，这些平台仅限于 Apple SDK：macosx、iphoneos、iphonesimulator、watchos、watchsimulator、appletvos、appletvsimulator。

注意： 因为目前仅支持 Apple 的平台，swift-create-xcframework 将忽略 Package.swift 中的 Linux 和其他平台。

swift create-xcframework --platform ios --platform macos ...

您可以通过在命令行上指定 --platform maccatalyst 来构建支持 Mac Catalyst 的 XCFramework。由于您无法在 Package.swift 中包含或排除 Catalyst 支持，因此我们不会尝试自动构建它。

因为我们封装了 xcodebuild，所以实际上您可以从任何可以映射到 Xcode 项目作为 Framework 目标的内容构建 XCFramework。这包括您的 Package 拥有的所有依赖项。

swift create-xcframework --list-products

swift create-xcframework Target1 Target2 Target3...

默认情况下，它构建您的 Package.swift 中的所有顶级 library 产品。

由于使用 swift-argument-parser 添加命令行选项的低摩擦性，因此有许多有用的命令行选项可用，因此 --help 应该是您的首选。

swift-create-xcframework 提供了 --zip 选项，可以自动将您新创建的 XCFramework 打包成 zip 文件，以便上传到 GitHub 作为发布工件，或您选择的任何位置。

如果您正在创建 XCFramework 的目标恰好是一个依赖项，swift-create-xcframework 将回顾包图，找到该依赖项解析到的版本，并将版本号附加到您的 zip 文件名。例如：ArgumentParser-0.0.6.zip

如果您创建的目标是根包中的产品，则不幸的是，没有标准方法来识别版本号。对于这些情况，您可以使用 --zip-version 指定一个版本号。

因为您可能希望将您的二进制框架作为 Swift 包分发，所以 swift create-xcframework --zip 也会计算必要的 SHA256 校验和，并将其与 zip 文件放在一起。例如：ArgumentParser-0.0.6.sha256。

swift-create-xcframework 包含一个 GitHub Action，当您在项目中标记发布版本时，它可以启动并自动创建 XCFramework。

该 action 为每个指定的目标生成一个压缩的 XCFramework 和校验和工件。

注意： 您必须使用基于 macOS 的 runner（例如 macos-latest），因为 xcodebuild 无法在 Linux 上运行。

name: Create Release

# Create XCFramework when a version is tagged
on:
  push:
    tags:

jobs:
  create_release:
    name: Create Release
    runs-on: macos-latest
    steps:

      - uses: actions/checkout@v2

      - name: Create XCFramework
        uses: unsignedapps/swift-create-xcframework@v2

      # Create a release
      # Upload those artifacts to the release

mint install unsignedapps/swift-create-xcframework

git clone https://github.com/unsignedapps/swift-create-xcframework.git
cd swift-create-xcframework
make install

两者都应该将 swift-create-xcframework 二进制文件放到 /usr/local/bin 中。并且由于 swift 二进制文件是可扩展的，因此您可以将其作为 swift 本身的子命令调用

swift create-xcframework --help

请阅读贡献指南，以了解如何为本项目做出贡献的详细信息。

swift-create-xcframework 在 MIT 许可证下可用。有关更多信息，请参阅 LICENSE 文件。

swift-create-xcframework

用法

选择要构建的内容

选择平台

Catalyst

选择产品

命令行选项

打包以进行分发

GitHub Action

.github/workflows/create-release.yml

安装

贡献

许可证