Merge branch 'zip-v3'

Author: paulb777

ReleaseTooling/DEVELOP.md

@@ -0,0 +1,97 @@
+# Firebase Release Tools
+
+This project includes Firebase release tooling including a zip builder and a
+Firebase release candidate creation tool.
+
+The tools are designed to fail fast with an explanation of what went wrong, so
+you can fix issues or dig in without having to dig too deep into the code.
+
+## Zip Builder
+
+For general usage, see [README.md](README.md).
+
+### Firebase Release zip building
+
+If the `--zip-pods` option is not specified, the tool will build a Firebase zip distribution.
+
+For release engineers (Googlers packaging an upcoming Firebase release) these commands should also
+be used:
+-  `--custom-spec-repos sso://cpdc-internal/firebase`
+  - This pulls the latest podspecs from the CocoaPods staging area.
+- `--enable-carthage-build` Turns on generation of Carthage zips and json file updates.
+- `--keep-build-artifacts` Useful for debugging and verifying the zip build contents.
+
+Putting them all together, here's a common command to build a releaseable Zip file:
+
+```
+swift run zip-builder --update-pod-repo \
+--custom-spec-repos sso://cpdc-internal/firebase \
+--enable-carthage-build \
+--keep-build-artifacts
+```
+
+#### Carthage
+
+Carthage binaries can also be built at the same time as the zip file by passing in `--enable-carthage-build`
+as a command line argument. This directory should contain JSON files describing versions and download
+locations for each product. This will result in a folder called "carthage" at the root where the zip directory exists
+containing all the zip files and JSON files necessary for distribution.
+
+## Firebase Releaser
+
+Provides several functions for staging a Firebase release candidate. See the internal go/firi link
+for the process documentation.
+
+### Launch Arguments
+
+See `main.swift` for information on specific launch arguments.
+
+You can pass in launch arguments with Xcode by selecting the  "firebase-releaser" scheme
+beside the Run/Stop buttons, clicking "Edit Scheme" and adding them in the "Arguments Passed On Launch"
+section.
+
+## Development Philosophy
+
+The following section describes the priorities taken while building this tool and should be followed
+for any modifications.
+
+### Readable and Maintainable
+This code will rarely be modified outside of bug fixes, but read very frequently. There should be no
+"magic lines" that do multiple things. Verbosity is preferred over making the code shorter and
+performing multiple actions at once. All functions should be well documented.
+
+### Avoid Calling bash Commands Where Possible
+Instead of using `cat`, `find`, `grep`, or `perl` use `String` APIs to read the contents of a file,
+`FileManager` to properly list contents of a directory, `RegularExpression` for pattern matching,
+etc. If there's a `Foundation` API available, it should be used.
+
+### Understandable Output
+The output of the script should make it immediately obvious if there were any issues and exactly
+what those issues were, without looking at the code. It should also be very clear if the Zip file
+was properly built and output the file location.
+
+### Show Xcode and API Output on Failures
+In the event that there's an Xcode build failure, the logs should be surfaced immediately to aid
+debugging. Release engineers should not have to find the Xcode project manually. That being said, a
+link to the Xcode project file should be logged as well in case it's necessary. Same goes for errors
+logged by exceptions (ex: `FileManager`).
+
+### Testable and Debuggable
+Components and functions should be split up in a way that make them easy to test and easy to debug.
+Prefer small functions that have proper failure conditions and input validated with `guard`
+statements, throwing `fatalError` with a well written error message if it's a critical issue that
+prevents the Zip file from being built properly.
+
+### Works from the Command Line or Xcode (Environment Agnostic)
+The script should be able to run from the command line to allow for easier automation and Xcode for
+simpler debugging and maintenance.
+
+### Any Failure Exits Immediately
+The script should not continue if anything necessary for a successful Zip file fails. This includes
+things like compiling storyboards, moving resources, missing files, etc. This is to ensure the
+integrity of the zip file and that any issues during testing are SDK bugs and not related to the
+files and folders.
+
+### Prefer File `URL`s over Strings
+Instead of relying on `String`s to represent file paths, use `URL`s as soon as possible to avoid any
+missed or double slashes along with other issues.

ReleaseTooling/README.md

@@ -3,13 +3,14 @@
 This project includes Firebase release tooling including a zip builder and a
 Firebase release candidate creation tool.
 
-The tools are designed to fail fast with an explanation of what went wrong, so
-you can fix issues or dig in without having to dig too deep into the code.
+The rest of this file documents using the `zip-builder` tool. Information about the rest of the
+tools for managing Firebase releases and information about developing these tools is at
+[DEVELOP.md](DEVELOP.md)
 
 ## Zip Builder
 
-This is a Swift Package Manager project that allows users to package an iOS Zip file of binary
-packages.
+The `zip-builder` tool generates a zip distribution of binary `.xcframeworks` from an input set of
+CocoaPods.
 
 ### Requirements
 
@@ -21,10 +22,10 @@ In order to build the Zip file, you will need:
 
 ### Running the Tool
 
-You can run the tool with `swift run zip-builder [ARGS]` or generate an Xcode project with
-`swift package generate-xcodeproj` and run within Xcode.
+You can run the tool with `swift run zip-builder [ARGS]` or `open Package.swift` to debug or run
+within Xcode.
 
-Since Apple does not support linking libraries built by future Xcode versions, make sure to builid with the
+Since Apple does not support linking libraries built by future Xcode versions, make sure to build with the
 earliest Xcode needed by any of the library clients. The Xcode command line tools must also be configured
 for that version. Check with `xcodebuild -version`.
 
@@ -37,14 +38,12 @@ You can pass in launch arguments with Xcode by clicking "zip-builder" beside the
 
 #### Common Arguments
 
-These arguments assume you're running the command from the `ReleaseTooling` directory.
+Use `pods <pods>` to specify the CocoaPods to build.
 
-**Required** arguments:
+The `pods` option will choose whatever pods get installed from an unversioned CocoaPods install,
+typically the latest versions.
 
-- `--repo-dir <PATH_TO_firebase_ios_sdk_REPO>`
-  - The root of the `firebase-ios-sdk` repo.
-
-Typical argument (all use cases except Firebase release build):
+To explicitly specify the CocoaPods versions, use a JSON specification :
 - `--zip-pods <PATH_TO.json>`
   - This is a JSON list of the pods to consolidate into a zip of binary frameworks. For example,
 
@@ -64,90 +63,13 @@ Indicates to install the version 3.2.0 of "GoogleDataTransport" and the latest
 version of "FirebaseMessaging". The version string is optional and can be any
 valid [CocoaPods Podfile version specifier](https://guides.cocoapods.org/syntax/podfile.html#pod).
 
-
-Optional common arguments:
+Other optional arguments:
 - `--no-update-pod-repo`
   - This is for speedups when `pod repo update` has already been run recently.
-
-For release engineers (Googlers packaging an upcoming Firebase release) these commands should also be used:
--  `--custom-spec-repos sso://cpdc-internal/firebase`
-  - This pulls the latest podspecs from the CocoaPods staging area.
-- `--repo-dir path` GitHub repo containing Template and Carthage json file inputs.
-- `--enable-carthage-build` Turns on generation of Carthage zips and json file updates.
-- `--keep-build-artifacts` Useful for debugging and verifying the zip build contents.
-
-Putting them all together, here's a common command to build a releaseable Zip file:
-
-```
-swift run zip-builder --update-pod-repo \
---repo-dir <PATH_TO_current.firebase_ios_sdk.repo> \
---custom-spec-repos sso://cpdc-internal/firebase \
---enable-carthage-build \
---keep-build-artifacts
-```
-
-### Carthage
-
-Carthage binaries can also be built at the same time as the zip file by passing in `--enable-carthage-build`
-as a command line argument. This directory should contain JSON files describing versions and download
-locations for each product. This will result in a folder called "carthage" at the root where the zip directory exists
-containing all the zip files and JSON files necessary for distribution.
-
-## Firebase Releaser
-
-Provides several functions for staging a Firebase release candidate. See the internal go/firi link
-for the process documentation.
-
-### Launch Arguments
-
-See `main.swift`  for information on specific launch arguments.
-
-You can pass in launch arguments with Xcode by selecting the  "firebase-releaser" scheme
-beside the Run/Stop buttons, clicking "Edit Scheme" and adding them in the "Arguments Passed On Launch"
-section.
-
-## Development Philosophy
-
-The following section describes the priorities taken while building this tool and should be followed
-for any modifications.
-
-### Readable and Maintainable
-This code will rarely be modified outside of bug fixes, but read very frequently. There should be no
-"magic lines" that do multiple things. Verbosity is preferred over making the code shorter and
-performing multiple actions at once. All functions should be well documented.
-
-### Avoid Calling bash Commands Where Possible
-Instead of using `cat`, `find`, `grep`, or `perl` use `String` APIs to read the contents of a file,
-`FileManager` to properly list contents of a directory, `RegularExpression` for pattern matching,
-etc. If there's a `Foundation` API available, it should be used.
-
-### Understandable Output
-The output of the script should make it immediately obvious if there were any issues and exactly
-what those issues were, without looking at the code. It should also be very clear if the Zip file
-was properly built and output the file location.
-
-### Show Xcode and API Output on Failures
-In the event that there's an Xcode build failure, the logs should be surfaced immediately to aid
-debugging. Release engineers should not have to find the Xcode project manually. That being said, a
-link to the Xcode project file should be logged as well in case it's necessary. Same goes for errors
-logged by exceptions (ex: `FileManager`).
-
-### Testable and Debuggable
-Components and functions should be split up in a way that make them easy to test and easy to debug.
-Prefer small functions that have proper failure conditions and input validated with `guard`
-statements, throwing `fatalError` with a well written error message if it's a critical issue that
-prevents the Zip file from being built properly.
-
-### Works from the Command Line or Xcode (Environment Agnostic)
-The script should be able to run from the command line to allow for easier automation and Xcode for
-simpler debugging and maintenance.
-
-### Any Failure Exits Immediately
-The script should not continue if anything necessary for a successful Zip file fails. This includes
-things like compiling storyboards, moving resources, missing files, etc. This is to ensure the
-integrity of the zip file and that any issues during testing are SDK bugs and not related to the
-files and folders.
-
-### Prefer File `URL`s over Strings
-Instead of relying on `String`s to represent file paths, use `URL`s as soon as possible to avoid any
-missed or double slashes along with other issues.
+- `--minimum-ios-version <minimum-ios-version>`
+  - Change the minimimum iOS version from the default of 10.
+- `--output-dir <output-dir>`
+  - The directory to copy the built Zip file. If this is not set, the path to the Zip file will
+  be logged to the console.
+- `--keep-build-artifacts`
+  - Keep the build artifacts.

ReleaseTooling/Sources/FirebaseManifest/FirebaseManifest.swift

@@ -30,26 +30,27 @@ public let shared = Manifest(
     Pod("FirebaseCore"),
     Pod("FirebaseInstallations"),
     Pod("FirebaseInstanceID"),
-    Pod("GoogleAppMeasurement", isClosedSource: true),
-    Pod("FirebaseAnalytics", isClosedSource: true, zip: true),
+    Pod("GoogleAppMeasurement", isClosedSource: true, platforms: ["ios"]),
+    Pod("FirebaseAnalytics", isClosedSource: true, platforms: ["ios"], zip: true),
     Pod("FirebaseABTesting", zip: true),
     Pod("FirebaseRemoteConfig", zip: true),
-    Pod("FirebaseAppDistribution", isBeta: true, zip: true),
+    Pod("FirebaseAppDistribution", isBeta: true, platforms: ["ios"], zip: true),
     Pod("FirebaseAuth", zip: true),
     Pod("FirebaseCrashlytics", zip: true),
     Pod("FirebaseDatabase", zip: true),
-    Pod("FirebaseDynamicLinks", zip: true),
+    Pod("FirebaseDynamicLinks", platforms: ["ios"], zip: true),
     Pod("FirebaseFirestore", allowWarnings: true, zip: true),
     Pod("FirebaseFirestoreSwift", isBeta: true),
     Pod("FirebaseFunctions", zip: true),
-    Pod("FirebaseInAppMessaging", isBeta: true, zip: true),
+    Pod("FirebaseInAppMessaging", isBeta: true, platforms: ["ios"], zip: true),
     Pod("FirebaseMessaging", zip: true),
-    Pod("FirebasePerformance", zip: true),
+    Pod("FirebasePerformance", platforms: ["ios"], zip: true),
     Pod("FirebaseStorage", zip: true),
     Pod("FirebaseStorageSwift", isBeta: true),
-    Pod("FirebaseMLCommon", isClosedSource: true, isBeta: true),
-    Pod("FirebaseMLModelInterpreter", isClosedSource: true, isBeta: true, zip: true),
-    Pod("FirebaseMLVision", isClosedSource: true, isBeta: true, zip: true),
+    Pod("FirebaseMLCommon", isClosedSource: true, isBeta: true, platforms: ["ios"]),
+    Pod("FirebaseMLModelInterpreter", isClosedSource: true, isBeta: true, platforms: ["ios"],
+        zip: true),
+    Pod("FirebaseMLVision", isClosedSource: true, isBeta: true, platforms: ["ios"], zip: true),
     Pod("Firebase", allowWarnings: true, zip: true),
   ]
 )

ReleaseTooling/Sources/FirebaseManifest/Pod.swift

@@ -23,6 +23,7 @@ public struct Pod {
   public let isBeta: Bool
   public let isFirebase: Bool
   public let allowWarnings: Bool // Allow validation warnings. Ideally these should all be false
+  public let platforms: Set<String> // Set of platforms to build this pod for
   public let podVersion: String? // Non-Firebase pods have their own version
   public let releasing: Bool // Non-Firebase pods may not release
   public let zip: Bool // Top level pod in Zip Distribution
@@ -32,6 +33,7 @@ public struct Pod {
        isBeta: Bool = false,
        isFirebase: Bool = true,
        allowWarnings: Bool = false,
+       platforms: Set<String> = ["ios", "macos", "tvos"],
        podVersion: String? = nil,
        releasing: Bool = true,
        zip: Bool = false) {
@@ -40,6 +42,7 @@ public struct Pod {
     self.isBeta = isBeta
     self.isFirebase = isFirebase
     self.allowWarnings = allowWarnings
+    self.platforms = platforms
     self.podVersion = podVersion
     self.releasing = releasing
     self.zip = zip