Add ZipBuilder support for tvOS and macOS (#7212)

Author: paulb777

.github/workflows/zip.yml

@@ -46,7 +46,7 @@ jobs:
 
   quickstart_framework_abtesting:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+#    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -91,7 +91,7 @@ jobs:
 
   quickstart_framework_auth:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -135,7 +135,7 @@ jobs:
 
   quickstart_framework_config:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -176,7 +176,7 @@ jobs:
 
   quickstart_framework_crashlytics:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -226,7 +226,7 @@ jobs:
 
   quickstart_framework_database:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -271,7 +271,7 @@ jobs:
 
   quickstart_framework_dynamiclinks:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -321,7 +321,7 @@ jobs:
 
   quickstart_framework_firestore:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -364,7 +364,7 @@ jobs:
 
   quickstart_framework_inappmessaging:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -410,7 +410,7 @@ jobs:
 
   quickstart_framework_messaging:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
@@ -455,7 +455,7 @@ jobs:
 
   quickstart_framework_storage:
     # Don't run on private repo.
-    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
+##    if: github.event_name == 'schedule' && github.repository == 'Firebase/firebase-ios-sdk'
     needs: package
     env:
       plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}

ReleaseTooling/README.md

@@ -71,3 +71,5 @@ Other optional arguments:
 - `--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

ReleaseTooling/Sources/ZipBuilder/CocoaPodUtils.swift

@@ -36,13 +36,40 @@ enum CocoaPodUtils {
 
   // MARK: - Public API
 
-  struct VersionedPod: Decodable, CustomDebugStringConvertible {
+  // Codable is required because Decodable does not make CodingKeys available.
+  struct VersionedPod: Codable, CustomDebugStringConvertible {
     /// Public name of the pod.
     let name: String
 
     /// The version of the requested pod.
     let version: String?
 
+    /// Platforms supported
+    let platforms: Set<String>
+
+    init(name: String,
+         version: String?,
+         platforms: Set<String> = ["ios", "macos", "tvos"]) {
+      self.name = name
+      self.version = version
+      self.platforms = platforms
+    }
+
+    init(from decoder: Decoder) throws {
+      let container = try decoder.container(keyedBy: CodingKeys.self)
+      name = try container.decode(String.self, forKey: .name)
+      if let platforms = try container.decodeIfPresent(Set<String>.self, forKey: .platforms) {
+        self.platforms = platforms
+      } else {
+        platforms = ["ios", "macos", "tvos"]
+      }
+      if let version = try container.decodeIfPresent(String.self, forKey: .version) {
+        self.version = version
+      } else {
+        version = nil
+      }
+    }
+
     /// The debug description as required by `CustomDebugStringConvertible`.
     var debugDescription: String {
       var desc = name
@@ -141,7 +168,7 @@ enum CocoaPodUtils {
   /// - Parameters:
   ///   - pods: List of VersionedPods to install
   ///   - directory: Destination directory for the pods.
-  ///   - minimumIOSVersion: The minimum iOS version as a string. Ex. `10.0`.
+  ///   - platform: Install for one platform at a time.
   ///   - customSpecRepos: Additional spec repos to check for installation.
   ///   - linkage: Specifies the linkage type. When `forcedStatic` is used, for the module map
   ///        construction, we want pod names not module names in the generated OTHER_LD_FLAGS
@@ -150,7 +177,7 @@ enum CocoaPodUtils {
   @discardableResult
   static func installPods(_ pods: [VersionedPod],
                           inDir directory: URL,
-                          minimumIOSVersion: String,
+                          platform: Platform,
                           customSpecRepos: [URL]?,
                           localPodspecPath: URL?,
                           linkage: LinkageType) -> [String: PodInfo] {
@@ -171,7 +198,7 @@ enum CocoaPodUtils {
       try writePodfile(for: pods,
                        toDirectory: directory,
                        customSpecRepos: customSpecRepos,
-                       minimumIOSVersion: minimumIOSVersion,
+                       platform: platform,
                        localPodspecPath: localPodspecPath,
                        linkage: linkage)
     } catch let FileManager.FileError.directoryNotFound(path) {
@@ -300,7 +327,7 @@ enum CocoaPodUtils {
     }
   }
 
-  static func podInstallPrepare(inProjectDir projectDir: URL, paths: ZipBuilder.FilesystemPaths) {
+  static func podInstallPrepare(inProjectDir projectDir: URL, templateDir: URL) {
     do {
       // Create the directory and all intermediate directories.
       try FileManager.default.createDirectory(at: projectDir, withIntermediateDirectories: true)
@@ -310,7 +337,7 @@ enum CocoaPodUtils {
     }
     // Copy the Xcode project needed in order to be able to install Pods there.
     let templateFiles = Constants.ProjectPath.requiredFilesForBuilding.map {
-      paths.templateDir.appendingPathComponent($0)
+      templateDir.appendingPathComponent($0)
     }
     for file in templateFiles {
       // Each file should be copied to the temporary project directory with the same name.
@@ -414,7 +441,7 @@ enum CocoaPodUtils {
   /// is not empty.
   private static func generatePodfile(for pods: [VersionedPod],
                                       customSpecsRepos: [URL]?,
-                                      minimumIOSVersion: String,
+                                      platform: Platform,
                                       localPodspecPath: URL?,
                                       linkage: LinkageType) -> String {
     // Start assembling the Podfile.
@@ -440,9 +467,9 @@ enum CocoaPodUtils {
       podfile += "  use_frameworks! :linkage => :static\n"
     }
 
-    // Include the minimum iOS version.
+    // Include the platform and its minimum version.
     podfile += """
-    platform :ios, '\(minimumIOSVersion)'
+    platform :\(platform.name), '\(platform.minimumVersion)'
     target 'FrameworkMaker' do\n
     """
 
@@ -504,7 +531,7 @@ enum CocoaPodUtils {
   private static func writePodfile(for pods: [VersionedPod],
                                    toDirectory directory: URL,
                                    customSpecRepos: [URL]?,
-                                   minimumIOSVersion: String,
+                                   platform: Platform,
                                    localPodspecPath: URL?,
                                    linkage: LinkageType) throws {
     guard FileManager.default.directoryExists(at: directory) else {
@@ -516,7 +543,7 @@ enum CocoaPodUtils {
     let path = directory.appendingPathComponent("Podfile")
     let podfile = generatePodfile(for: pods,
                                   customSpecsRepos: customSpecRepos,
-                                  minimumIOSVersion: minimumIOSVersion,
+                                  platform: platform,
                                   localPodspecPath: localPodspecPath,
                                   linkage: linkage)
     do {

ReleaseTooling/Sources/ZipBuilder/FirebaseBuilder.swift

@@ -30,13 +30,11 @@ struct FirebaseBuilder {
 
   /// Wrapper around a generic zip builder that adds in Firebase specific steps including a
   /// multi-level zip file, a README, and optionally Carthage artifacts.
-  func build(in projectDir: URL,
-             minimumIOSVersion: String,
+  func build(templateDir: URL,
              carthageBuildOptions: CarthageBuildOptions?) {
     // Build the zip file and get the path.
     do {
-      let artifacts = try zipBuilder.buildAndAssembleFirebaseRelease(inProjectDir: projectDir,
-                                                                     minimumIOSVersion: minimumIOSVersion,
+      let artifacts = try zipBuilder.buildAndAssembleFirebaseRelease(templateDir: templateDir,
                                                                      includeCarthage: carthageBuildOptions !=
                                                                        nil)
       let firebaseVersion = artifacts.firebaseVersion