fastlane_hotfix 2.165.1 → 2.187.0

data/deliver/lib/deliver/module.rb

@@ -4,6 +4,12 @@ require 'fastlane/boolean'
 
 module Deliver
   class << self
+    attr_accessor :cache
+
+    def cache
+      @cache ||= {}
+      @cache
+    end
   end
 
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore

data/deliver/lib/deliver/options.rb

@@ -13,7 +13,7 @@ module Deliver
 
       [
         FastlaneCore::ConfigItem.new(key: :api_key_path,
-                                     env_name: "DELIVER_API_KEY_PATH",
+                                     env_names: ["DELIVER_API_KEY_PATH", "APP_STORE_CONNECT_API_KEY_PATH"],
                                      description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
                                      optional: true,
                                      conflicting_options: [:api_key],
@@ -21,7 +21,7 @@ module Deliver
                                        UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
                                      end),
         FastlaneCore::ConfigItem.new(key: :api_key,
-                                     env_name: "DELIVER_API_KEY",
+                                     env_names: ["DELIVER_API_KEY", "APP_STORE_CONNECT_API_KEY"],
                                      description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
                                      type: Hash,
                                      optional: true,
@@ -32,6 +32,7 @@ module Deliver
                                      short_option: "-u",
                                      env_name: "DELIVER_USERNAME",
                                      description: "Your Apple ID Username",
+                                     optional: true,
                                      default_value: user,
                                      default_value_dynamic: true),
         FastlaneCore::ConfigItem.new(key: :app_identifier,
@@ -108,11 +109,11 @@ module Deliver
                                      default_value: false,
                                      env_name: "DELIVER_EDIT_LIVE",
                                      description: "Modify live metadata, this option disables ipa upload and screenshot upload",
-                                     is_string: false),
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :use_live_version,
                                      env_name: "DELIVER_USE_LIVE_VERSION",
                                      description: "Force usage of live version rather than edit version",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
 
         # paths
@@ -131,22 +132,22 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :skip_binary_upload,
                                      env_name: "DELIVER_SKIP_BINARY_UPLOAD",
                                      description: "Skip uploading an ipa or pkg to App Store Connect",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :skip_screenshots,
                                      env_name: "DELIVER_SKIP_SCREENSHOTS",
                                      description: "Don't upload the screenshots",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :skip_metadata,
                                      env_name: "DELIVER_SKIP_METADATA",
                                      description: "Don't upload the metadata (e.g. title, description). This will still upload screenshots",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :skip_app_version_update,
                                      env_name: "DELIVER_SKIP_APP_VERSION_UPDATE",
                                      description: "Don’t create or update the app version that is being prepared for submission",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
 
         # how to operate
@@ -154,22 +155,22 @@ module Deliver
                                      short_option: "-f",
                                      env_name: "DELIVER_FORCE",
                                      description: "Skip verification of HTML preview file",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :overwrite_screenshots,
                                      env_name: "DELIVER_OVERWRITE_SCREENSHOTS",
                                      description: "Clear all previously uploaded screenshots before uploading the new ones",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :submit_for_review,
                                      env_name: "DELIVER_SUBMIT_FOR_REVIEW",
                                      description: "Submit the new version for Review after uploading everything",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :reject_if_possible,
                                      env_name: "DELIVER_REJECT_IF_POSSIBLE",
                                      description: "Rejects the previously submitted build if it's in a state where it's possible",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
 
         # release
@@ -197,13 +198,13 @@ module Deliver
                                      env_name: "DELIVER_PHASED_RELEASE",
                                      description: "Enable the phased release feature of iTC",
                                      optional: true,
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :reset_ratings,
                                     env_name: "DELIVER_RESET_RATINGS",
                                     description: "Reset the summary rating when you release a new version of the application",
                                     optional: true,
-                                    is_string: false,
+                                    type: Boolean,
                                     default_value: false),
 
         # other app configuration
@@ -211,13 +212,12 @@ module Deliver
                                      short_option: "-r",
                                      env_name: "DELIVER_PRICE_TIER",
                                      description: "The price tier of this application",
-                                     is_string: false,
+                                     type: Integer,
                                      optional: true),
         FastlaneCore::ConfigItem.new(key: :app_rating_config_path,
                                      short_option: "-g",
                                      env_name: "DELIVER_APP_RATING_CONFIG_PATH",
                                      description: "Path to the app rating's config",
-                                     is_string: true,
                                      optional: true,
                                      verify_block: proc do |value|
                                        UI.user_error!("Could not find config file at path '#{File.expand_path(value)}'") unless File.exist?(value)
@@ -226,7 +226,6 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :submission_information,
                                      short_option: "-b",
                                      description: "Extra information for the submission (e.g. compliance specifications, IDFA settings)",
-                                     is_string: false,
                                      type: Hash,
                                      optional: true),
 
@@ -236,7 +235,7 @@ module Deliver
                                      env_name: "DELIVER_TEAM_ID",
                                      description: "The ID of your App Store Connect team if you're in multiple teams",
                                      optional: true,
-                                     is_string: false, # as we also allow integers, which we convert to strings anyway
+                                     skip_type_validation: true, # as we also allow integers, which we convert to strings anyway
                                      code_gen_sensitive: true,
                                      default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                      default_value_dynamic: true,
@@ -259,7 +258,6 @@ module Deliver
                                      env_name: "DELIVER_DEV_PORTAL_TEAM_ID",
                                      description: "The short ID of your Developer Portal team, if you're in multiple teams. Different from your iTC team ID!",
                                      optional: true,
-                                     is_string: true,
                                      code_gen_sensitive: true,
                                      default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
                                      default_value_dynamic: true,
@@ -277,7 +275,7 @@ module Deliver
                                      verify_block: proc do |value|
                                        ENV["FASTLANE_TEAM_NAME"] = value.to_s
                                      end),
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         FastlaneCore::ConfigItem.new(key: :itc_provider,
                                      env_name: "DELIVER_ITC_PROVIDER",
                                      description: "The provider short name to be used with the iTMSTransporter to identify your team. This value will override the automatically detected provider short name. To get provider short name run `pathToXcode.app/Contents/Applications/Application\\ Loader.app/Contents/itms/bin/iTMSTransporter -m provider -u 'USERNAME' -p 'PASSWORD' -account_type itunes_connect -v off`. The short names of providers should be listed in the second column",
@@ -285,20 +283,20 @@ module Deliver
                                      code_gen_sensitive: true,
                                      default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_provider),
                                      default_value_dynamic: true),
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         # precheck
         FastlaneCore::ConfigItem.new(key: :run_precheck_before_submit,
                                      short_option: "-x",
                                      env_name: "DELIVER_RUN_PRECHECK_BEFORE_SUBMIT",
                                      description: "Run precheck before submitting to app review",
-                                     is_string: false,
+                                     type: Boolean,
                                      default_value: true),
         FastlaneCore::ConfigItem.new(key: :precheck_default_rule_level,
                                      short_option: "-d",
                                      env_name: "DELIVER_PRECHECK_DEFAULT_RULE_LEVEL",
                                      description: "The default precheck rule level unless otherwise configured",
-                                     is_string: false,
+                                     type: Symbol,
                                      default_value: :warn),
 
         # App Metadata
@@ -306,7 +304,6 @@ module Deliver
                                      env_name: "DELIVER_INDIVUDAL_METADATA_ITEMS",
                                      description: "An array of localized metadata items to upload individually by language so that errors can be identified. E.g. ['name', 'keywords', 'description']. Note: slow",
                                      deprecated: "Removed after the migration to the new App Store Connect API in June 2020",
-                                     is_string: false,
                                      type: Array,
                                      optional: true),
 
@@ -326,66 +323,56 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :copyright,
                                      env_name: "DELIVER_COPYRIGHT",
                                      description: "Metadata: The copyright notice",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :primary_category,
                                      env_name: "DELIVER_PRIMARY_CATEGORY",
                                      description: "Metadata: The english name of the primary category (e.g. `Business`, `Books`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :secondary_category,
                                      env_name: "DELIVER_SECONDARY_CATEGORY",
                                      description: "Metadata: The english name of the secondary category (e.g. `Business`, `Books`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :primary_first_sub_category,
                                      env_name: "DELIVER_PRIMARY_FIRST_SUB_CATEGORY",
                                      description: "Metadata: The english name of the primary first sub category (e.g. `Educational`, `Puzzle`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :primary_second_sub_category,
                                      env_name: "DELIVER_PRIMARY_SECOND_SUB_CATEGORY",
                                      description: "Metadata: The english name of the primary second sub category (e.g. `Educational`, `Puzzle`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :secondary_first_sub_category,
                                      env_name: "DELIVER_SECONDARY_FIRST_SUB_CATEGORY",
                                      description: "Metadata: The english name of the secondary first sub category (e.g. `Educational`, `Puzzle`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :secondary_second_sub_category,
                                      env_name: "DELIVER_SECONDARY_SECOND_SUB_CATEGORY",
                                      description: "Metadata: The english name of the secondary second sub category (e.g. `Educational`, `Puzzle`)",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :trade_representative_contact_information,
                                      description: "Metadata: A hash containing the trade representative contact information",
                                      optional: true,
-                                     is_string: false,
+                                     deprecated: "This is no longer used by App Store Connect",
                                      type: Hash),
         FastlaneCore::ConfigItem.new(key: :app_review_information,
                                      description: "Metadata: A hash containing the review information",
                                      optional: true,
-                                     is_string: false,
                                      type: Hash),
         FastlaneCore::ConfigItem.new(key: :app_review_attachment_file,
                                      env_name: "DELIVER_APP_REVIEW_ATTACHMENT_FILE",
                                      description: "Metadata: Path to the app review attachment file",
-                                     optional: true,
-                                     is_string: true),
+                                     optional: true),
         # Localised
         FastlaneCore::ConfigItem.new(key: :description,
                                      description: "Metadata: The localised app description",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :name,
                                      description: "Metadata: The localised app name",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :subtitle,
                                      description: "Metadata: The localised app subtitle",
                                      optional: true,
-                                     is_string: false,
                                      type: Hash,
                                      verify_block: proc do |value|
                                        UI.user_error!(":subtitle must be a hash, with the language being the key") unless value.kind_of?(Hash)
@@ -393,7 +380,6 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :keywords,
                                      description: "Metadata: An array of localised keywords",
                                      optional: true,
-                                     is_string: false,
                                      type: Hash,
                                      verify_block: proc do |value|
                                        UI.user_error!(":keywords must be a hash, with the language being the key") unless value.kind_of?(Hash)
@@ -408,7 +394,6 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :promotional_text,
                                      description: "Metadata: An array of localised promotional texts",
                                      optional: true,
-                                     is_string: false,
                                      type: Hash,
                                      verify_block: proc do |value|
                                        UI.user_error!(":keywords must be a hash, with the language being the key") unless value.kind_of?(Hash)
@@ -416,23 +401,23 @@ module Deliver
         FastlaneCore::ConfigItem.new(key: :release_notes,
                                      description: "Metadata: Localised release notes for this version",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :privacy_url,
                                      description: "Metadata: Localised privacy url",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :apple_tv_privacy_policy,
                                      description: "Metadata: Localised Apple TV privacy policy text",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :support_url,
                                      description: "Metadata: Localised support url",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         FastlaneCore::ConfigItem.new(key: :marketing_url,
                                      description: "Metadata: Localised marketing url",
                                      optional: true,
-                                     is_string: false),
+                                     type: Hash),
         # The verify_block has been removed from here and verification now happens in Deliver::DetectValues
         # Verification needed Spaceship::Tunes.client which required the Deliver::Runner to already by started
         FastlaneCore::ConfigItem.new(key: :languages,
@@ -444,11 +429,11 @@ module Deliver
                                      env_name: "DELIVER_IGNORE_LANGUAGE_DIRECTORY_VALIDATION",
                                      description: "Ignore errors when invalid languages are found in metadata and screenshot directories",
                                      default_value: false,
-                                     is_string: false),
+                                     type: Boolean),
         FastlaneCore::ConfigItem.new(key: :precheck_include_in_app_purchases,
                                      env_name: "PRECHECK_INCLUDE_IN_APP_PURCHASES",
                                      description: "Should precheck check in-app purchases?",
-                                     is_string: false,
+                                     type: Boolean,
                                      optional: true,
                                      default_value: true),
 
@@ -457,7 +442,8 @@ module Deliver
                                      short_option: "-p",
                                      env_name: "DELIVER_APP_ID",
                                      description: "The (spaceship) app ID of the app you want to use/modify",
-                                     is_string: false) # don't add any verification here, as it's used to store a spaceship ref
+                                     optional: true,
+                                     type: Integer)
       ]
     end
   end

data/deliver/lib/deliver/runner.rb

@@ -26,10 +26,16 @@ module Deliver
     end
 
     def login
-      if api_token
+      if (api_token = Spaceship::ConnectAPI::Token.from(hash: options[:api_key], filepath: options[:api_key_path]))
         UI.message("Creating authorization token for App Store Connect API")
         Spaceship::ConnectAPI.token = api_token
+      elsif !Spaceship::ConnectAPI.token.nil?
+        UI.message("Using existing authorization token for App Store Connect API")
       else
+        # Username is now optional since addition of App Store Connect API Key
+        # Force asking for username to prompt user if not already set
+        options.fetch(:username, force_ask: true)
+
         # Team selection passed though FASTLANE_TEAM_ID and FASTLANE_TEAM_NAME environment variables
         # Prompts select team if multiple teams and none specified
         UI.message("Login to App Store Connect (#{options[:username]})")
@@ -38,12 +44,6 @@ module Deliver
       end
     end
 
-    def api_token
-      @api_token ||= Spaceship::ConnectAPI::Token.create(options[:api_key]) if options[:api_key]
-      @api_token ||= Spaceship::ConnectAPI::Token.from_json_file(options[:api_key_path]) if options[:api_key_path]
-      return @api_token
-    end
-
     def run
       verify_version if options[:app_version].to_s.length > 0 && !options[:skip_app_version_update]
 
@@ -83,7 +83,7 @@ module Deliver
 
       if options[:api_key] || options[:api_key_path]
         if options[:precheck_include_in_app_purchases]
-          UI.user_error!("Precheck cannot check In-app purchases with the App Store Connect API Key (yet). Exclude In-app purchases from precheck or use Apple ID login")
+          UI.user_error!("Precheck cannot check In-app purchases with the App Store Connect API Key (yet). Exclude In-app purchases from precheck, disable the precheck step in your build step, or use Apple ID login")
         end
 
         precheck_options[:api_key] = options[:api_key]
@@ -114,7 +114,7 @@ module Deliver
       app_version = options[:app_version]
       UI.message("Making sure the latest version on App Store Connect matches '#{app_version}'...")
 
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       changed = app.ensure_version!(app_version, platform: platform)
@@ -163,14 +163,14 @@ module Deliver
 
       if upload_ipa
         package_path = FastlaneCore::IpaUploadPackageBuilder.new.generate(
-          app_id: options[:app].id,
+          app_id: Deliver.cache[:app].id,
           ipa_path: options[:ipa],
           package_path: "/tmp",
           platform: options[:platform]
         )
       elsif upload_pkg
         package_path = FastlaneCore::PkgUploadPackageBuilder.new.generate(
-          app_id: options[:app].id,
+          app_id: Deliver.cache[:app].id,
           pkg_path: options[:pkg],
           package_path: "/tmp",
           platform: options[:platform]
@@ -178,12 +178,16 @@ module Deliver
       end
 
       transporter = transporter_for_selected_team
-      result = transporter.upload(options[:app].id, package_path)
-      UI.user_error!("Could not upload binary to App Store Connect. Check out the error above", show_github_issues: true) unless result
+      result = transporter.upload(package_path: package_path)
+
+      unless result
+        transporter_errors = transporter.displayable_errors
+        UI.user_error!("Error uploading ipa file: \n #{transporter_errors}")
+      end
     end
 
     def reject_version_if_possible
-      app = options[:app]
+      app = Deliver.cache[:app]
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       if app.reject_version_if_possible!(platform: platform)
         UI.success("Successfully rejected previous version!")
@@ -202,6 +206,7 @@ module Deliver
     # If there are fewer than two teams, don't infer the provider.
     def transporter_for_selected_team
       # Use JWT auth
+      api_token = Spaceship::ConnectAPI.token
       unless api_token.nil?
         api_token.refresh! if api_token.expired?
         return FastlaneCore::ItunesTransporter.new(nil, nil, false, nil, api_token.text)

data/deliver/lib/deliver/setup.rb

@@ -1,4 +1,3 @@
-require 'open-uri'
 require 'spaceship/tunes/tunes'
 
 require_relative 'module'
@@ -40,13 +39,13 @@ module Deliver
     # This method takes care of creating a new 'deliver' folder, containing the app metadata
     # and screenshots folders
     def generate_deliver_file(deliver_path, options)
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       v = app.get_latest_app_store_version(platform: platform)
 
       metadata_path = options[:metadata_path] || File.join(deliver_path, 'metadata')
-      generate_metadata_files(app, v, metadata_path)
+      generate_metadata_files(app, v, metadata_path, options)
 
       # Generate the final Deliverfile here
       return File.read(deliverfile_path)
@@ -60,9 +59,14 @@ module Deliver
       end
     end
 
-    def generate_metadata_files(app, version, path)
+    def generate_metadata_files(app, version, path, options)
       # App info localizations
-      app_info = app.fetch_live_app_info || app.fetch_edit_app_info
+      if options[:use_live_version]
+        app_info = app.fetch_live_app_info
+        UI.user_error!("The option `use_live_version` was set to `true`, however no live app was found on App Store Connect.") unless app_info
+      else
+        app_info = app.fetch_edit_app_info || app.fetch_live_app_info
+      end
       app_info_localizations = app_info.get_app_info_localizations
       app_info_localizations.each do |localization|
         language = localization.locale