Added the --zip-version option

Author: bok-

README.md

@@ -1,6 +1,6 @@
 # swift-create-xcframework
 
-`swift-create-xcframework` is a very simple tool designed to wrap `xcodebuild` and the process of creating multiple frameworks for a Swift Package and merging them into a single XCFramework.
+swift-create-xcframework is a very simple tool designed to wrap `xcodebuild` and the process of creating multiple frameworks for a Swift Package and merging them into a single XCFramework.
 
 ## Usage
 
@@ -10,9 +10,9 @@ Inside your Swift Package folder you can just run:
 swift create-xcframework
 ```
 
-By default `swift-create-xcframework` will build XCFrameworks for all library products in your Package.swift, or any targets you specify on the command line (this can be for any dependencies you include as well).
+By default swift-create-xcframework will build XCFrameworks for all library products in your Package.swift, or any targets you specify on the command line (this can be for any dependencies you include as well).
 
-Then for every target or product specified, `swift-create-xcframework` will:
+Then for every target or product specified, swift-create-xcframework will:
 
 1. Generate an Xcode Project for your package (in `.build/swift-create-xcframework`).
 2. Build a `.framework` for each supported platform/SDK.
@@ -42,14 +42,14 @@ var package = Package(
 )
 ```
 
-By default `swift-create-xcframework` will build `ExampleGenerator.xcframework` that supports: macosx, iphoneos, iphonesimulator. Additional `.library` products would be built automatically as well.
+By default swift-create-xcframework will build `ExampleGenerator.xcframework` that supports: macosx, iphoneos, iphonesimulator. Additional `.library` products would be built automatically as well.
 
 ### Choosing Platforms
 
 You can narrow down what gets built 
 If you omit the platforms specification, we'll build for all platforms that support Swift Binary Frameworks, which at the time of writing is just the Apple SDKs: macosx, iphoneos, iphonesimulator, watchos, watchsimulator, appletvos, appletvsimulator.
 
-**Note:** Because only Apple's platforms are supported at this time, `swift-create-xcframework` will ignore Linux and other platforms in the Package.swift.
+**Note:** Because only Apple's platforms are supported at this time, swift-create-xcframework will ignore Linux and other platforms in the Package.swift.
 
 You can specify a subset of the platforms to build using the `--platform` option, for example:
 
@@ -79,6 +79,14 @@ By default it builds all top-level library products in your Package.swift.
 
 Because of the low-friction to adding command line options with [swift-argument-parser](https://github.com/apple/swift-argument-parser), there are a number of useful command line options available, so `--help` should be your first port of call.
 
+## Packaging for distribution
+
+swift-create-xcframework provides a `--zip` option to automatically zip up your newly created XCFrameworks ready for upload to GitHub as a release artefact, or anywhere you choose.
+
+If the target you are creating an XCFramework happens to be a dependency, swift-create-xcframework will look back into the package graph, locate the version that dependency resolved to, and append the version number to your zip file name. eg: `ArgumentParser-0.0.6.zip`
+
+If the target you are creating is a product from the root package, unfortunately there is no standard way to identify the version number. For those cases you can specify one with `--zip-version`.
+
 ## Installation
 
 You can install using mint:
@@ -95,7 +103,7 @@ cd swift-create-xcframework
 make install
 ```
 
-Either should pop the `swift-create-xcframework` binary into `/usr/local/bin`. And because the `swift` binary is extensible, you can then call it as a subcommand of `swift` itself:
+Either should pop the swift-create-xcframework binary into `/usr/local/bin`. And because the `swift` binary is extensible, you can then call it as a subcommand of `swift` itself:
 
 ```shell
 swift create-xcframework --help

Sources/CreateXCFramework/Command+Options.swift

@@ -43,6 +43,9 @@ extension Command {
         @Flag(help: "Whether to wrap the .xcframework(s) up in a versioned zip file ready for deployment")
         var zip: Bool
 
+        @Option(help: ArgumentHelp("The version number to append to the name of the zip file\n\nIf the target you are packaging is a dependency, swift-create-xcframework will look into the package graph and locate the version number the dependency resolved to. As there is no standard way to specify the version inside your Swift Package, --zip-version lets you specify it manually.", valueName: "version"))
+        var zipVersion: String?
+ 
 
         // MARK: - Targets
 

Sources/CreateXCFramework/Command.swift

@@ -96,7 +96,7 @@ struct Command: ParsableCommand {
             let zipper = Zipper(package: package)
             try xcframeworkFiles
                 .forEach { pair in
-                    try zipper.zip(target: pair.0, file: pair.1)
+                    try zipper.zip(target: pair.0, version: self.options.zipVersion, file: pair.1)
                     try zipper.clean(file: pair.1)
                 }
         }

Sources/CreateXCFramework/Zipper.swift

@@ -23,9 +23,9 @@ struct Zipper {
 
     // MARK: - Zippering
 
-    func zip (target: String, file: Foundation.URL) throws {
+    func zip (target: String, version: String?, file: Foundation.URL) throws {
 
-        let suffix = self.versionSuffix(target: target) ?? ""
+        let suffix = self.versionSuffix(target: target, default: version) ?? ""
         let zipPath = file.path.replacingOccurrences(of: "\\.xcframework$", with: "\(suffix).zip", options: .regularExpression)
         let zipURL = URL(fileURLWithPath: zipPath)
 
@@ -58,7 +58,7 @@ struct Zipper {
         ]
     }
 
-    private func versionSuffix (target: String) -> String? {
+    private func versionSuffix (target: String, default fallback: String?) -> String? {
 
         // find the package that contains our target
         guard let packageRef = self.package.graph.packages.first(where: { $0.targets.contains(where: { $0.name == target } ) }) else { return nil }
@@ -72,7 +72,7 @@ struct Zipper {
             case let .checkout(checkout) = dependency.state,
             let version = checkout.version
         else {
-            return nil
+            return fallback.flatMap { "-" + $0 }
         }
 
         return "-" + version.description