Replace ImageMagick with a custom tool written in swift.

.github/workflows/pr-build.yml

@@ -41,7 +41,7 @@ jobs:
           p12-password: ${{ secrets.ALPHA_CERTIFICATES_P12_PASSWORD }}
 
       - name: Build alpha
-        run: bundle exec fastlane alpha
+        run: bundle exec fastlane build_alpha
         env:
           APPSTORECONNECT_KEY_ID: ${{ secrets.APPSTORECONNECT_KEY_ID }}
           APPSTORECONNECT_KEY_ISSUER_ID: ${{ secrets.APPSTORECONNECT_KEY_ISSUER_ID }}

Tools/Sources/AppIconBanner.swift

@@ -0,0 +1,67 @@
+import ArgumentParser
+import SwiftUI
+
+struct AppIconBanner: AsyncParsableCommand {
+    static var configuration = CommandConfiguration(
+        abstract: "A Swift command-line tool to add a banner to an app icons."
+    )
+    
+    @Argument(help: "Path to the input image.")
+    var path: String
+        
+    @Option(help: "Text for the banner.")
+    var bannerText: String
+        
+    @MainActor
+    func run() async throws {
+        let currentDirectoryURL = URL(filePath: FileManager.default.currentDirectoryPath)
+        let pathURL = currentDirectoryURL.appending(path: path)
+        
+        guard let image = NSImage(contentsOf: pathURL) else {
+            throw ValidationError("Could not load the image at \(pathURL).")
+        }
+        
+        let renderer = ImageRenderer(content: BannerImage(image: image,
+                                                          text: bannerText))
+        
+        do {
+            guard let cgImage = renderer.cgImage else {
+                throw ValidationError("Couldn't generate CG image.")
+            }
+            
+            let bitmap = NSBitmapImageRep(cgImage: cgImage)
+            
+            guard let pngData = bitmap.representation(using: .png, properties: [:]) else {
+                throw ValidationError("Couldn't create png data from image.")
+            }
+            
+            try pngData.write(to: pathURL)
+            print("Successfully saved the image with a banner to \(pathURL).")
+        } catch {
+            throw ValidationError("Failed to save the image: \(error).")
+        }
+    }
+}
+
+struct BannerImage: View {
+    let image: NSImage
+    let text: String
+    
+    var body: some View {
+        ZStack(alignment: .bottom) {
+            Image(nsImage: image)
+                .resizable()
+                .aspectRatio(contentMode: .fit)
+            
+            Text(text)
+                .frame(maxWidth: .infinity)
+                .padding()
+                .background(Color.black.opacity(0.5))
+                .foregroundColor(.white)
+                .font(.system(size: 140))
+                .lineLimit(1)
+                .allowsTightening(true)
+        }
+        .frame(width: image.size.width, height: image.size.height)
+    }
+}

Tools/Sources/Tools.swift

@@ -2,7 +2,7 @@ import ArgumentParser
 import Foundation
 
 @main
-struct Tools: ParsableCommand {
+struct Tools: AsyncParsableCommand {
     static var configuration = CommandConfiguration(abstract: "A collection of command line tools for ElementX",
                                                     subcommands: [BuildSDK.self,
                                                                   SetupProject.self,
@@ -10,5 +10,6 @@ struct Tools: ParsableCommand {
                                                                   DownloadStrings.self,
                                                                   Locheck.self,
                                                                   GenerateSDKMocks.self,
-                                                                  GenerateSAS.self])
+                                                                  GenerateSAS.self,
+                                                                  AppIconBanner.self])
 }

ci_scripts/ci_common.sh

@@ -31,11 +31,6 @@ setup_xcode_cloud_environment () {
 
 install_xcode_cloud_brew_dependencies () {
     brew update && brew install xcodegen
-    
-    if [ "$CI_WORKFLOW" = "Nightly" ]; then
-        brew install imagemagick@6
-        brew link imagemagick@6 # imagemagick@6 is keg-only, which means it was not symlinked into /usr/local,
-    fi
 }
 
 setup_github_actions_environment() {
@@ -44,11 +39,6 @@ setup_github_actions_environment() {
     
     brew update && brew install xcodegen swiftformat git-lfs a7ex/homebrew-formulae/xcresultparser
     
-    if [ "$CI_WORKFLOW" = "PR_BUILD" ]; then
-        brew install imagemagick@6
-        brew link imagemagick@6 # imagemagick@6 is keg-only, which means it was not symlinked into /usr/local,
-    fi
-    
     # brew "swiftlint" # Fails on the CI: `Target /usr/local/bin/swiftlint Target /usr/local/bin/swiftlint already exists`. Installed through https://github.com/actions/virtual-environments/blob/main/images/macos/macos-12-Readme.md#linters
 
     bundle config path vendor/bundle

fastlane/Fastfile

@@ -14,14 +14,14 @@ before_all do
   ENV["SENTRY_LOG_LEVEL"] = "DEBUG"
 end
 
-lane :alpha do
+lane :build_alpha do
   app_store_connect_api_key(
     key_id: ENV["APPSTORECONNECT_KEY_ID"],
     issuer_id: ENV["APPSTORECONNECT_KEY_ISSUER_ID"],
     key_content: ENV["APPSTORECONNECT_KEY_CONTENT"]
   )
 
-  config_xcodegen_alpha()
+  config_alpha()
 
   code_signing_identity = "Apple Distribution: Vector Creations Limited (7J4U792NQT)"
   
@@ -184,7 +184,9 @@ lane :config_nightly do |options|
 
   release_version = get_version_number(target: "ElementX")
 
-  update_app_icon(caption_text: "#{release_version} (#{build_number})", modulate: "100,20,100")
+  Dir.chdir ".." do
+    sh("swift run tools app-icon-banner Variants/Nightly/Resources/Nightly.xcassets/NightlyAppIcon.appiconset/AppIcon.png --banner-text '#{release_version} (#{build_number})'")
+  end
 end
 
 $sentry_retry=0
@@ -311,7 +313,7 @@ private_lane :git_push do |options|
   sh("git push https://#{api_token}@#{repo_url}")
 end
 
-private_lane :config_xcodegen_alpha do
+lane :config_alpha do
   target_file_path = "../project.yml"
   data = YAML.load_file target_file_path
   data["include"].append({ "path" => "Variants/Alpha/alpha.yml" })
@@ -321,7 +323,9 @@ private_lane :config_xcodegen_alpha do
 
   version = ENV["GITHUB_PR_NUMBER"]
 
-  update_app_icon(caption_text: "PR #{version}", modulate: "100,100,200")
+  Dir.chdir ".." do
+    sh("swift run tools app-icon-banner Variants/Alpha/Resources/Alpha.xcassets/AlphaAppIcon.appiconset/AppIcon.png --banner-text 'PR #{version}'")
+  end
 
   bump_build_number()
 end
@@ -371,26 +375,6 @@ private_lane :bump_build_number do
   increment_build_number(build_number: build_number)
 end
 
-private_lane :update_app_icon do |options|
-  caption_text = options[:caption_text]
-  UI.user_error!("Invalid caption text.") unless !caption_text.to_s.empty?
-
-  modulate = options[:modulate]
-  UI.user_error!("Invalid icon modulate parameters.") unless !modulate.to_s.empty?
-
-  Dir.glob("../ElementX/Resources/Assets.xcassets/AppIcon.appiconset/**/*.png") do |file_name|
-    # Change the icons color
-    sh("convert '#{file_name}' -modulate #{modulate} '#{file_name}'")
-
-    image_width = sh("identify -format %w '#{file_name}'")
-    image_height = sh("identify -format %h '#{file_name}'").to_i
-    caption_height = image_height / 5
-
-    # Add a label on top
-    sh("convert -background '#0008' -fill white -gravity center -size '#{image_width}'x'#{caption_height}' caption:'#{caption_text}' '#{file_name}' +swap -gravity south -composite '#{file_name}'")
-  end
-end
-
 private_lane :create_simulator_if_necessary do |options|
   simulator_name = options[:name]
   UI.user_error!("Invalid simulator name") unless !simulator_name.to_s.empty?