Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mussacharles/xcframeworkscripts
Useful Scripts used to build XCFramework and links to learning materials.
https://github.com/mussacharles/xcframeworkscripts
spm xcframework xcframeworks xcode
Last synced: 23 days ago
JSON representation
Useful Scripts used to build XCFramework and links to learning materials.
- Host: GitHub
- URL: https://github.com/mussacharles/xcframeworkscripts
- Owner: MussaCharles
- License: mit
- Created: 2022-09-20T09:16:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-21T11:15:58.000Z (over 2 years ago)
- Last Synced: 2024-11-09T03:30:25.044Z (3 months ago)
- Topics: spm, xcframework, xcframeworks, xcode
- Homepage:
- Size: 84 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XCFrameworkScripts
Useful Scripts used to build XCFramework and links to learning materials.
## Introduction
The following scripts can be copy pasted to terminal (Make sure you are inside a project folder) and produce .framework then the final script is used to combine the individual generated archives into single .XCFramework ready for distribution.
Note: Before creating an xcframework builds needs to be archived for all supported architectures as shown on the steps below.
## Archive for iOS iPhone (Release)
```shell
xcodebuild archive \
-scheme \
-configuration Release \
-destination 'generic/platform=iOS' \
-archivePath './build/.framework-iphoneos.xcarchive' \
SKIP_INSTALL=NO \
BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
```
The above command will generate an archive of your framework by using the following list as inputs :
1. **-scheme **: It’ll use this scheme for archiving (Make sure you specify a project name/scheme as it appear on the Xcode project).
2. **-configuration Release**: It’ll use the release configuration for building.
3. **-destination ‘generic/platform=iOS’**: This is the architecture type.
4. **-archivePath**: It saves archives into this folder path with the given name.
5. **SKIP_INSTALL**: Set NO to install the framework to the archive.
6. **BUILD_LIBRARIES_FOR_DISTRIBUTION**: Ensures your libraries are built for distribution and creates the interface file.
## Archive for iOS Simulator (Release)
```shell
xcodebuild archive \
-scheme \
-configuration Release \
-destination 'generic/platform=iOS Simulator' \
-archivePath './build/.framework-iphonesimulator.xcarchive' \
SKIP_INSTALL=NO \
BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
```
These command options are the same as those for iOS except for the following differences:
1. **-destination ‘generic/platform=iOS Simulator’**: This is where you set the architecture type.
2. **-archivePath**: This generates the archive into the folder path with the given name.
## Archive for macOS (Release)
```shell
xcodebuild archive \
-scheme \
-configuration Release \
-destination 'platform=macOS,arch=x86_64,variant=Mac Catalyst' \
-archivePath './build/.framework-catalyst.xcarchive' \
SKIP_INSTALL=NO \
BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
```
This command is the same as the others except for the following differences:
1. **-destination ‘platform=macOS,arch=x86_64,variant=Mac Catalyst’**: This is where you indicate the architecture type.
2. **-archivePath**: This generates the archive into the folder path with the given name.
## Generate XCFramework
This command adds your XCFramework to the build folder using the generated archives above.
```shell
xcodebuild -create-xcframework \
-framework './build/.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/.framework' \
-framework './build/.framework-iphoneos.xcarchive/Products/Library/Frameworks/.framework' \
-framework './build/.framework-catalyst.xcarchive/Products/Library/Frameworks/.framework' \
-output './build/.xcframework'
```
# Learning Materials
As I was working working with XCFrameworks, I found the following online learning materials to be very helpful. These can act as a shortcut to quickly read or watch about frameworks or packages without spending much time to search on the web.
## Binary Frameworks
1. [Apple Docs: Distributing Binary Frameworks as Swift Packages](https://developer.apple.com/documentation/xcode/distributing-binary-frameworks-as-swift-packages)
2. [Medium: Binary Frameworks in Swift — XCFrameworks](https://medium.com/macoclock/binary-frameworks-in-swift-xcframeworks-5bd35f50e13a)
3. [WWDC 2019: Binary frameworks in Swift](https://developer.apple.com/wwdc19/416)
4. [WWDC 2020: Distribute Binary frameworks as Swift packages](https://developer.apple.com/wwdc20/10147)
5. [iOS Deep Understanding of Libraries and Frameworks](https://www.youtube.com/watch?v=lGG0UPdvc54&t=1225s&ab_channel=WizelineAcademy)
## Adding SPM to existing frameworks/libraries
1. Article -> [Creating a Swift Package from an existing iOS Framework (Library)](https://emmanuelkehinde.io/creating-a-swift-package-from-an-existing-ios-framework-library/)
2. Medium -> [Creating XCFramework from Swift Package](https://mustafa-ysf.medium.com/creating-xcframework-from-swift-package-e8af6f44501f)
3. Article -> [How to create a Swift Package from a CocoaPods project](https://dragosneagu.com/how-to-create-a-swift-package-from-an-existing-cocoapods-project/)
## Swift Package Manager
- [Package Manager Official Documentation](https://www.swift.org/package-manager/)
- [SPM Package manifest file docs](https://docs.swift.org/package-manager/PackageDescription/PackageDescription.html)
- [WWDC 2018: Getting to Know Swift Package Manager](https://developer.apple.com/videos/play/wwdc2018/411/)
- [WWDC 2019, Creating Swift packages](https://developer.apple.com/wwdc19/410)
- [WWDC 2019: Adopt Swift Packages in Xcode](https://developer.apple.com/wwdc19/408)
- [WWDC 2021: Swift packages collections (grouping)](https://developer.apple.com/wwdc21/10197)
- [WWDC 2022: Swift package plugins](https://developer.apple.com/wwdc22/110359)
- [Swift by Sundell:Managing dependencies using the Swift Package Manager](https://www.swiftbysundell.com/articles/managing-dependencies-using-the-swift-package-manager/)
- [Apple Docs: Creating a Standalone Swift Package with Xcode](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode)
- [Apple Docs: Bundling Resources with a Swift Package](https://developer.apple.com/documentation/xcode/bundling-resources-with-a-swift-package)
- [Stackoverflow: Add demo app to SPM](https://stackoverflow.com/a/69659509/7551807)
- As a side note, project should be closed before following the steps on the linked answer.
- [Medium article: SPM with mixed Swift and ObjC files](https://joesusnick.medium.com/swift-package-manager-with-a-mixed-swift-and-objective-c-project-part-1-2-19fbb43d0460)
- [Apple Docs: Organizing Your Code with Local Packages](https://developer.apple.com/documentation/xcode/organizing-your-code-with-local-packages)
- [Apple Docs: Developing a Swift Package in Tandem with an App](https://developer.apple.com/documentation/xcode/developing-a-swift-package-in-tandem-with-an-app)
- [Apple Docs: Editing a Package Dependency as a Local Package](https://developer.apple.com/documentation/xcode/editing-a-package-dependency-as-a-local-package)
- [Swift Heroes: Advanced Swift Package Manager](https://www.youtube.com/watch?v=g9bBph435Lc&ab_channel=SwiftHeroes)
## Credits
1. [Raywenderlich -> Creating a Framework for iOS](https://www.raywenderlich.com/17753301-creating-a-framework-for-ios#toc-anchor-002)
2. [Official Apple Docs -> Create an XCFramework](https://help.apple.com/xcode/mac/11.4/#/dev544efab96)
3. [Raywenderlich -> Swift Package Manager for iOS](https://www.raywenderlich.com/7242045-swift-package-manager-for-ios)
## Related open source projects
The following is the list of open source projects which automate the process or creating frameworks.
- [swift-create-xcframework](https://github.com/unsignedapps/swift-create-xcframework)
- [surmagic](https://github.com/gurhub/surmagic)