Always build Carthage with Firebase zip distributions (#8098)

Author: paulb777

ReleaseTooling/DEVELOP.md

@@ -18,23 +18,21 @@ For release engineers (Googlers packaging an upcoming Firebase release) these co
 be used:
 -  `--custom-spec-repos https://github.com/firebase/SpecsStaging.git`
   - 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 https://github.com/firebase/SpecsStaging.git \
---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
+Carthage binaries can also be built at the same time as the zip file. 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

ReleaseTooling/Sources/ZipBuilder/FirebaseBuilder.swift

@@ -31,25 +31,20 @@ 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(templateDir: URL,
-             carthageBuildOptions: CarthageBuildOptions?) {
+             carthageBuildOptions: CarthageBuildOptions) {
     // Build the zip file and get the path.
     do {
-      let artifacts = try zipBuilder.buildAndAssembleFirebaseRelease(templateDir: templateDir,
-                                                                     includeCarthage: carthageBuildOptions !=
-                                                                       nil)
+      let artifacts = try zipBuilder.buildAndAssembleFirebaseRelease(templateDir: templateDir)
       let firebaseVersion = artifacts.firebaseVersion
       let location = artifacts.zipDir
       print("Firebase \(firebaseVersion) directory is ready to be packaged: \(location)")
 
       // Package carthage if it's enabled.
-      var carthageRoot: URL?
-      if let carthageBuildOptions = carthageBuildOptions {
-        carthageRoot = CarthageUtils.packageCarthageRelease(
-          templateDir: zipBuilder.paths.templateDir,
-          artifacts: artifacts,
-          options: carthageBuildOptions
-        )
-      }
+      let carthageRoot = CarthageUtils.packageCarthageRelease(
+        templateDir: zipBuilder.paths.templateDir,
+        artifacts: artifacts,
+        options: carthageBuildOptions
+      )
 
       // Prepare the release directory for zip packaging.
       do {

ReleaseTooling/Sources/ZipBuilder/ZipBuilder.swift

@@ -162,8 +162,7 @@ struct ZipBuilder {
   /// - Parameter podsToInstall: All pods to install.
   /// - Returns: Arrays of pod install info and the frameworks installed.
   func buildAndAssembleZip(podsToInstall: [CocoaPodUtils.VersionedPod],
-                           includeDependencies: Bool,
-                           includeCarthage: Bool = false) ->
+                           includeDependencies: Bool) ->
     ([String: CocoaPodUtils.PodInfo], [String: [URL]], URL) {
     // Remove CocoaPods cache so the build gets updates after a version is rebuilt during the
     // release process. Always do this, since it can be the source of subtle failures on rebuilds.
@@ -304,10 +303,8 @@ struct ZipBuilder {
   /// encounters an error, or will quit due to a fatal error with the appropriate log.
   ///
   /// - Parameter templateDir: The template project for pod install.
-  /// - Parameter includeCarthage: Whether to build and package Carthage.
   /// - Throws: One of many errors that could have happened during the build phase.
-  func buildAndAssembleFirebaseRelease(templateDir: URL,
-                                       includeCarthage: Bool) throws -> ReleaseArtifacts {
+  func buildAndAssembleFirebaseRelease(templateDir: URL) throws -> ReleaseArtifacts {
     let manifest = FirebaseManifest.shared
     var podsToInstall = manifest.pods.filter { $0.zip }.map {
       CocoaPodUtils.VersionedPod(name: $0.name,
@@ -330,8 +327,7 @@ struct ZipBuilder {
     let (installedPods, frameworks, carthageCoreDiagnosticsXcframework) =
       buildAndAssembleZip(podsToInstall: podsToInstall,
                           // Always include dependencies for Firebase zips.
-                          includeDependencies: true,
-                          includeCarthage: includeCarthage)
+                          includeDependencies: true)
 
     // We need the Firebase pod to get the version for Carthage and to copy the `Firebase.h` and
     // `module.modulemap` file from it.
@@ -345,17 +341,14 @@ struct ZipBuilder {
                                            installedPods: installedPods,
                                            frameworksToAssemble: frameworks,
                                            firebasePod: firebasePod)
-    var carthageDir: URL?
-    if includeCarthage {
-      // Replace Core Diagnostics
-      var carthageFrameworks = frameworks
-      carthageFrameworks["FirebaseCoreDiagnostics"] = [carthageCoreDiagnosticsXcframework]
-      carthageDir = try assembleDistributions(withPackageKind: "CarthageFirebase",
-                                              podsToInstall: podsToInstall,
-                                              installedPods: installedPods,
-                                              frameworksToAssemble: carthageFrameworks,
-                                              firebasePod: firebasePod)
-    }
+    // Replace Core Diagnostics
+    var carthageFrameworks = frameworks
+    carthageFrameworks["FirebaseCoreDiagnostics"] = [carthageCoreDiagnosticsXcframework]
+    let carthageDir = try assembleDistributions(withPackageKind: "CarthageFirebase",
+                                                podsToInstall: podsToInstall,
+                                                installedPods: installedPods,
+                                                frameworksToAssemble: carthageFrameworks,
+                                                firebasePod: firebasePod)
 
     return ReleaseArtifacts(firebaseVersion: firebasePod.version,
                             zipDir: zipDir, carthageDir: carthageDir)

ReleaseTooling/Sources/ZipBuilder/main.swift

@@ -53,12 +53,6 @@ struct ZipBuilderTool: ParsableCommand {
         help: ArgumentHelp("Whether or not to build dependencies of requested pods."))
   var buildDependencies: Bool
 
-  /// Flag to also build Carthage artifacts.
-  @Flag(default: false,
-        inversion: .prefixedEnableDisable,
-        help: ArgumentHelp("A flag specifying to build Carthage artifacts."))
-  var carthageBuild: Bool
-
   /// Flag to enable or disable Carthage version checks. Skipping the check can speed up dev
   /// iterations.
   @Flag(default: true,
@@ -306,12 +300,9 @@ struct ZipBuilderTool: ParsableCommand {
       // pod's podspec options.
       PlatformMinimum.useRecentVersions()
 
-      var carthageOptions: CarthageBuildOptions?
-      if carthageBuild {
-        let jsonDir = paths.repoDir.appendingPathComponents(["ReleaseTooling", "CarthageJSON"])
-        carthageOptions = CarthageBuildOptions(jsonDir: jsonDir,
-                                               isVersionCheckEnabled: carthageVersionCheck)
-      }
+      let jsonDir = paths.repoDir.appendingPathComponents(["ReleaseTooling", "CarthageJSON"])
+      let carthageOptions = CarthageBuildOptions(jsonDir: jsonDir,
+                                                 isVersionCheckEnabled: carthageVersionCheck)
 
       FirebaseBuilder(zipBuilder: builder).build(templateDir: paths.templateDir,
                                                  carthageBuildOptions: carthageOptions)

scripts/build_zip.sh

@@ -35,5 +35,5 @@ read -a specrepo <<< "${CUSTOM_SPEC_REPOS}"
 cd ReleaseTooling
 swift run zip-builder --keep-build-artifacts --update-pod-repo \
     --local-podspec-path "${REPO}" \
-    --enable-carthage-build --output-dir "${OUTPUT_DIR}" \
+    --output-dir "${OUTPUT_DIR}" \
     --custom-spec-repos  "${specrepo[@]}"