RubyGems - fastlane-plugin-altoolalt - Versions diffs - 1.2.0 → 1.3.0 - Mend

fastlane-plugin-altoolalt 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml +4 -4
data/README.md +108 -30
data/lib/fastlane/plugin/altoolalt/actions/altoolalt_action.rb +207 -16
data/lib/fastlane/plugin/altoolalt/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce6c8c68423d1ba9017e5436c69fa012acf28cece7ac7553656bc49fbfcee8c0
-  data.tar.gz: b841d6b1d472a044ed2c76ca827bba773fa9e7d151f7648d46856d70b9d70743
+  metadata.gz: d6c9572b5575d43a4619c4562a6ab14f0b6b87fc88ff76fa4736261a468da447
+  data.tar.gz: 3941b4ed4ed5c1fc8ffcdde9f6714d2d76576145ce8314d5a8095c0e2817ccc3
 SHA512:
-  metadata.gz: eb1fa24f8b367aab99595e47485cc29465c5d6dedb52426c46f367f50002fd4327e88e4c12f3efff1becb8d119a46ee052d752c391872f317912e6f350b2b26f
-  data.tar.gz: 5189d9630f9ba82dbcddf31be0d40d71adb28d1239609d1c31d87734124d1ada5b2bb6c64bea66b3956ec67047e7a667a6c46011e68707bc080196344fa5d0eb
+  metadata.gz: 9353a87e96259e966012aefd7edd7a22723f36d2d26f76626bb99d3cbf26ef5a94c239a5378592cdef9447e36c8239acae216817b77b3aa3ce8ad215d00ba59f
+  data.tar.gz: b26e26d67c7aba61175828f9890d3b56e9c0ddb4ae3b20fcf797dbda766c5544bfcef18d16ac76485ffe23ecccc15341b9b6998086e31842b9aacf744ba25b3c

data/README.md CHANGED Viewed

@@ -1,15 +1,19 @@
-# altool plugin
+# altoolalt plugin
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-altool)
-<a href="https://travis-ci.org/Shashikant86/fastlane-plugin-altool/"><img src="https://img.shields.io/travis/Shashikant86/fastlane-plugin-altool.svg" /></a>
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-altoolalt)
 ## Getting Started
-This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-altool`, add it to your project by running:
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-altoolalt`, add it to your project by running:
 ```bash
-fastlane add_plugin altool
+fastlane add_plugin altoolalt
+```
+Or add to your `Gemfile`:
+```ruby
+gem 'fastlane-plugin-altoolalt'
 ```
 ## Pre-requisite
@@ -26,51 +30,125 @@ $ export FASTLANE_PASSWORD="your_super_xecret_password";
 You can do the same for your choice of shell if you aren't using bash.
-## About altool
+## About
+This plugin provides an alternative way to upload IPA files to App Store Connect (formerly iTunes Connect) using Apple's `altool` command-line tool instead of the standard iTMSTransporter.
-This plugin can be used to upload IPA to iTunes Connect using altool.
+### Why use altool?
-Currently Fastlane deliver uses iTMSTransporter to upload an ipa files to iTunes Connect but there is slick way to do this using `altool`
+- **Faster uploads** - altool is often faster than iTMSTransporter
+- **Modern API support** - Supports both legacy and modern upload methods
+- **Flexible authentication** - Username/password or API Key authentication
+- **Auto-extraction** (v1.3.0+) - Automatically extracts bundle metadata from IPA
-This plugin can be used for uploading generated `ipa` file using Gym to iTunes Connect.
+### Features
-This plugin assume that, you already have that Fastlane setup and your details are configured as ENV variables in `FASTLANE_USER` and `FASTLANE_PASSWORD` by default.
+- ✅ Support for both `--upload-app` (legacy) and `--upload-package` (modern) methods
+- ✅ Automatic extraction of bundle_id, bundle_version, and bundle_short_version_string from IPA
+- ✅ API Key authentication (recommended) or username/password
+- ✅ Support for iOS, macOS, tvOS, and visionOS apps
+- ✅ Multi-provider account support
+- ✅ Comprehensive error handling and validation
 ## Usage
-You can configure this plugin using
+### Basic Usage (Legacy Method)
+Use the traditional `--upload-app` method with username/password:
 ```ruby
-    altool(
-        username: ENV["FASTLANE_USER"],
-        password: ENV["FASTLANE_PASSWORD"],
-        app_type: "ios",
-        ipa_path: "./build/Your-ipa.ipa",
-        output_format: "xml",
-    )
+altoolalt(
+    username: ENV["FASTLANE_USER"],
+    password: ENV["FASTLANE_PASSWORD"],
+    app_type: "ios",
+    ipa_path: "./build/Your-ipa.ipa",
+    output_format: "xml"
+)
+```
+Or with API Key authentication (recommended):
+```ruby
+altoolalt(
+    api_key_id: ENV["APP_STORE_CONNECT_API_KEY_ID"],
+    api_issuer: ENV["APP_STORE_CONNECT_ISSUER_ID"],
+    app_type: "ios",
+    ipa_path: "./build/Your-ipa.ipa",
+    output_format: "xml"
+)
 ```
-OR
+### Modern Method (v1.3.0+) - with Auto-Extraction
+Use the newer `--upload-package` method with automatic bundle metadata extraction:
 ```ruby
-    altool(
-        api_key_id: "<YOUR_API_KEY_ID>",
-        api_issuer: "<YOUR_API_ISSUER>",
-        app_type: "ios",
-        ipa_path: "./build/Your-ipa.ipa",
-        output_format: "xml",
-    )
+altoolalt(
+    use_upload_package: true,
+    api_key_id: ENV["APP_STORE_CONNECT_API_KEY_ID"],
+    api_issuer: ENV["APP_STORE_CONNECT_ISSUER_ID"],
+    apple_id: "1234567890",  # Your App's Apple ID from App Store Connect
+    ipa_path: "./build/Your-ipa.ipa"
+    # bundle_id, bundle_version, and bundle_short_version_string
+    # are automatically extracted from the IPA!
+)
+```
+The plugin will automatically extract `bundle_id`, `bundle_version`, and `bundle_short_version_string` from your IPA's Info.plist. You can still override these if needed:
+```ruby
+altoolalt(
+    use_upload_package: true,
+    api_key_id: ENV["APP_STORE_CONNECT_API_KEY_ID"],
+    api_issuer: ENV["APP_STORE_CONNECT_ISSUER_ID"],
+    apple_id: "1234567890",
+    ipa_path: "./build/Your-ipa.ipa",
+    bundle_id: "com.example.app",  # Optional: override auto-extraction
+    bundle_version: "1.0",
+    bundle_short_version_string: "1.0.0"
+)
 ```
-Security Note:
-This might print the username and password to build console in the commands, pipe the output to ` /dev/null` or use similar approach so that fastlane don't print command to console.
+**Security Note:**
+This might print the username and password to build console in the commands. For username/password authentication, consider using API Keys instead, or pipe the output to `/dev/null`.
+## Available Parameters
+### Common Parameters
+| Parameter | Description | Required | Default |
+|-----------|-------------|----------|---------|
+| `ipa_path` | Path to your IPA file | Yes | Most recent .ipa in current directory |
+| `api_key_id` | App Store Connect API Key ID | Yes* | `ENV["ALTOOL_API_KEY"]` |
+| `api_issuer` | App Store Connect API Issuer ID | Yes* | - |
+| `username` | Apple ID username | Yes* | `ENV["FASTLANE_USER"]` |
+| `password` | Apple ID password | Yes* | `ENV["FASTLANE_PASSWORD"]` |
+| `output_format` | Output format (normal, xml, json) | No | `normal` |
+\* Either `api_key_id`+`api_issuer` OR `username`+`password` is required
+### Legacy Method Parameters (use_upload_package: false)
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `app_type` | Platform type (ios, osx, appletvos) | `ios` |
+### Modern Method Parameters (use_upload_package: true)
+| Parameter | Description | Required | Auto-extracted |
+|-----------|-------------|----------|----------------|
+| `use_upload_package` | Enable modern upload method | No (false) | - |
+| `apple_id` | App's Apple ID from App Store Connect | Yes | ❌ No |
+| `platform` | Platform (ios, macos, appletvos, visionos) | No (ios) | - |
+| `bundle_id` | Bundle identifier | No | ✅ Yes |
+| `bundle_version` | CFBundleVersion | No | ✅ Yes |
+| `bundle_short_version_string` | CFBundleShortVersionString | No | ✅ Yes |
+| `provider_public_id` | Provider ID (for multi-provider accounts) | No | - |
 ## Example Project Repo
-This is a example project [Altool-Demo](https://github.com/Shashikant86/Altool-Demo) available on GitHub which has its own README.
+This is an example project [Altool-Demo](https://github.com/Shashikant86/Altool-Demo) available on GitHub which has its own README.
 ## Run tests for this plugin

data/lib/fastlane/plugin/altoolalt/actions/altoolalt_action.rb CHANGED Viewed

@@ -13,34 +13,158 @@ module Fastlane
         app_type = params[:app_type]
         ipa_path = "\"#{params[:ipa_path]}\""
         output_format = params[:output_format]
+        use_upload_package = params[:use_upload_package]
         UI.message("========Validating and Uploading your IPA file to iTunes Connect=========")
+        # Build command based on upload method
+        if use_upload_package
+          command = build_upload_package_command(altool, params, ipa_path, output_format)
+        else
+          command = build_upload_app_command(altool, params, ipa_path, app_type, output_format)
+        end
+        Actions.sh(command.join(' '))
+        UI.message("========It might take long time to fully upload your IPA file=========")
+      end
+      def self.build_upload_app_command(altool, params, ipa_path, app_type, output_format)
         command = [
           altool,
           '--upload-app',
+          '-f',
+          ipa_path,
           '-t',
           app_type,
-          '-f',
+          '--output-format',
+          output_format
+        ]
+        add_authentication(command, params)
+        command
+      end
+      def self.build_upload_package_command(altool, params, ipa_path, output_format)
+        # Get parameters - will try to extract from IPA if not provided
+        apple_id = params[:apple_id]
+        bundle_version = params[:bundle_version]
+        bundle_short_version = params[:bundle_short_version_string]
+        bundle_id = params[:bundle_id]
+        platform = params[:platform]
+        # Auto-extract bundle metadata from IPA if not all parameters provided
+        if bundle_version.to_s.empty? || bundle_short_version.to_s.empty? || bundle_id.to_s.empty?
+          UI.message("Attempting to extract bundle metadata from IPA...")
+          extracted = extract_bundle_metadata_from_ipa(ipa_path)
+          if extracted
+            bundle_id ||= extracted[:bundle_id]
+            bundle_version ||= extracted[:bundle_version]
+            bundle_short_version ||= extracted[:bundle_short_version_string]
+          end
+        end
+        # Validate required parameters (after potential extraction)
+        if apple_id.to_s.empty?
+          UI.user_error!("--upload-package requires apple_id parameter (App ID from App Store Connect)")
+        end
+        if bundle_version.to_s.empty? || bundle_short_version.to_s.empty? || bundle_id.to_s.empty?
+          UI.user_error!("--upload-package requires: bundle_version, bundle_short_version_string, and bundle_id. " \
+                         "These can be provided as parameters or will be auto-extracted from the IPA.")
+        end
+        command = [
+          altool,
+          '--upload-package',
           ipa_path,
+          '-t',
+          platform || 'ios',
+          '--apple-id',
+          apple_id,
+          '--bundle-version',
+          bundle_version,
+          '--bundle-short-version-string',
+          bundle_short_version,
+          '--bundle-id',
+          bundle_id,
+          '--output-format',
           output_format
         ]
+        # Add provider-public-id if specified (required for multi-provider accounts with username/password)
+        provider_id = params[:provider_public_id]
+        if !provider_id.to_s.empty?
+          command.concat(['--provider-public-id', provider_id])
+        end
+        add_authentication(command, params)
+        command
+      end
+      def self.add_authentication(command, params)
         api_key_id = params[:api_key_id]
         api_issuer = params[:api_issuer]
         if !api_key_id.to_s.empty? && !api_issuer.to_s.empty?
-          command += ['--apiKey', api_key_id, '--apiIssuer', api_issuer]
+          command.concat(['--api-key', api_key_id, '--api-issuer', api_issuer])
         else
           username = params[:username]
           ENV["ALTOOL_PASSWORD"] = params[:password]
           password = "@env:ALTOOL_PASSWORD"
           if username.to_s.empty? || password.to_s.empty?
-            UI.user_error!("You must provide either api_key and api_issuer or username and password")
+            UI.user_error!("You must provide either api_key_id and api_issuer or username and password")
           end
-          command += ['--username', username, '--password', password]
+          command.concat(['--username', username, '--password', password])
         end
+      end
-        Actions.sh(command.join(' '))
-        UI.message("========It might take long time to fully upload your IPA file=========")
+      def self.extract_bundle_metadata_from_ipa(ipa_path)
+        require 'tmpdir'
+        require 'json'
+        # Remove quotes from ipa_path if present
+        clean_ipa_path = ipa_path.gsub(/^"|"$/, '')
+        Dir.mktmpdir do |temp_dir|
+          # Extract IPA (which is a ZIP archive)
+          unzip_command = "unzip -q \"#{clean_ipa_path}\" -d \"#{temp_dir}\" 2>/dev/null"
+          system(unzip_command)
+          # Find Info.plist in the Payload directory
+          info_plist_path = Dir.glob("#{temp_dir}/Payload/*.app/Info.plist").first
+          unless info_plist_path
+            UI.important("Could not find Info.plist in IPA, will require manual bundle parameters")
+            return nil
+          end
+          # Convert Info.plist to JSON using plutil
+          json_output = `plutil -convert json -o - "#{info_plist_path}" 2>/dev/null`
+          if $?.exitstatus != 0
+            UI.important("Failed to parse Info.plist with plutil")
+            return nil
+          end
+          plist_data = JSON.parse(json_output)
+          metadata = {
+            bundle_id: plist_data['CFBundleIdentifier'],
+            bundle_version: plist_data['CFBundleVersion'],
+            bundle_short_version_string: plist_data['CFBundleShortVersionString']
+          }
+          UI.message("Extracted bundle metadata from IPA:")
+          UI.message("  Bundle ID: #{metadata[:bundle_id]}")
+          UI.message("  Bundle Version: #{metadata[:bundle_version]}")
+          UI.message("  Short Version: #{metadata[:bundle_short_version_string]}")
+          metadata
+        rescue => e
+          UI.important("Error extracting bundle metadata: #{e.message}")
+          nil
+        end
       end
       def self.description
@@ -62,13 +186,26 @@ module Fastlane
       def self.available_options
         [
+          FastlaneCore::ConfigItem.new(key: :use_upload_package,
+                                    env_name: "ALTOOL_USE_UPLOAD_PACKAGE",
+                                    description: "Use --upload-package instead of --upload-app (newer method, requires additional parameters)",
+                                    default_value: false,
+                                    is_string: false,
+                                    optional: true),
           FastlaneCore::ConfigItem.new(key: :app_type,
                                     env_name: "ALTOOL_APP_TYPE",
-                                    description: "Type or platform of application e.g osx, ios, appletvos ",
+                                    description: "Type or platform of application e.g osx, ios, appletvos (used with --upload-app)",
                                     default_value: "ios",
                                     is_string: true,
                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                    env_name: "ALTOOL_PLATFORM",
+                                    description: "Platform for --upload-package: macos, ios, appletvos, visionos (defaults to ios if not specified)",
+                                    is_string: true,
+                                    optional: true),
           FastlaneCore::ConfigItem.new(key: :ipa_path,
                                     env_name: "ALTOOL_IPA_PATH",
                                     description: "Path to IPA file ",
@@ -94,7 +231,7 @@ module Fastlane
                                     is_string: true,
                                     default_value: ENV["FASTLANE_PASSWORD"],
                                     optional: true),
           FastlaneCore::ConfigItem.new(key: :api_key_id,
                                     env_name: "ALTOOL_API_KEY_ID",
                                     description: "Only specify the Key ID without the AuthKey_ and .p8. Place the file in ~/private_keys/ or ~/.private_keys/ or ~/.appstoreconnect/private_keys/ or private_keys/ in directory where altool is excuted",
@@ -108,6 +245,36 @@ module Fastlane
                                     is_string: true,
                                     optional: true),
+          FastlaneCore::ConfigItem.new(key: :apple_id,
+                                    env_name: "ALTOOL_APPLE_ID",
+                                    description: "The Apple ID (App ID) of the app (required for --upload-package)",
+                                    is_string: true,
+                                    optional: true),
+          FastlaneCore::ConfigItem.new(key: :bundle_version,
+                                    env_name: "ALTOOL_BUNDLE_VERSION",
+                                    description: "The CFBundleVersion of the app (required for --upload-package, auto-extracted from IPA if not provided)",
+                                    is_string: true,
+                                    optional: true),
+          FastlaneCore::ConfigItem.new(key: :bundle_short_version_string,
+                                    env_name: "ALTOOL_BUNDLE_SHORT_VERSION_STRING",
+                                    description: "The CFBundleShortVersionString of the app (required for --upload-package, auto-extracted from IPA if not provided)",
+                                    is_string: true,
+                                    optional: true),
+          FastlaneCore::ConfigItem.new(key: :bundle_id,
+                                    env_name: "ALTOOL_BUNDLE_ID",
+                                    description: "The bundle identifier of the app (required for --upload-package, auto-extracted from IPA if not provided)",
+                                    is_string: true,
+                                    optional: true),
+          FastlaneCore::ConfigItem.new(key: :provider_public_id,
+                                    env_name: "ALTOOL_PROVIDER_PUBLIC_ID",
+                                    description: "Provider ID (required for --upload-package with username/password when account has multiple providers)",
+                                    is_string: true,
+                                    optional: true),
           FastlaneCore::ConfigItem.new(key: :output_format,
                                     env_name: "ALTOOL_OUTPUT_FORMAT",
                                     description: "Output formal xml or normal ",
@@ -119,21 +286,45 @@ module Fastlane
       end
       def self.example_code
-        ['   altool_alt(
+        [
+          '# Legacy method using --upload-app (still supported)
+          altool_alt(
             username: ENV["FASTLANE_USER"],
             password: ENV["FASTLANE_PASSWORD"],
             app_type: "ios",
             ipa_path: "./build/Your-ipa.ipa",
-            output_format: "xml",
-        )
-       ',
-         '   altool_alt(
-            api_key: "<YOUR_API_KEY_ID>",
+            output_format: "xml"
+          )',
+          '# Legacy method with API Key authentication
+          altool_alt(
+            api_key_id: "<YOUR_API_KEY_ID>",
             api_issuer: "<YOUR_API_ISSUER>",
             app_type: "ios",
             ipa_path: "./build/Your-ipa.ipa",
-            output_format: "xml",
-        )'
+            output_format: "xml"
+          )',
+          '# Newer method using --upload-package with auto-extraction of bundle metadata
+          altool_alt(
+            use_upload_package: true,
+            api_key_id: "<YOUR_API_KEY_ID>",
+            api_issuer: "<YOUR_API_ISSUER>",
+            platform: "ios",
+            ipa_path: "./build/Your-ipa.ipa",
+            apple_id: "1234567890"
+          )',
+          '# Newer method with explicit bundle metadata (if auto-extraction fails)
+          altool_alt(
+            use_upload_package: true,
+            username: ENV["FASTLANE_USER"],
+            password: ENV["FASTLANE_PASSWORD"],
+            platform: "ios",
+            ipa_path: "./build/Your-ipa.ipa",
+            apple_id: "1234567890",
+            bundle_version: "1.0",
+            bundle_short_version_string: "1.0.0",
+            bundle_id: "com.example.app",
+            output_format: "xml"
+          )'
         ]
       end

data/lib/fastlane/plugin/altoolalt/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Fastlane
   module Altoolalt
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-altoolalt
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Anand Biligiri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry