fastlane_hotfix 2.165.0 → 2.187.0

data/deliver/lib/deliver/submit_for_review.rb

@@ -7,7 +7,7 @@ require 'fastlane_core/pkg_file_analyser'
 module Deliver
   class SubmitForReview
     def submit!(options)
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       version = app.get_edit_app_store_version(platform: platform)
@@ -57,7 +57,7 @@ module Deliver
 
     def update_export_compliance(options, app, build)
       submission_information = options[:submission_information] || {}
-      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
+      submission_information = submission_information.transform_keys(&:to_sym)
 
       uses_encryption = submission_information[:export_compliance_uses_encryption]
 
@@ -87,7 +87,7 @@ module Deliver
 
     def update_idfa(options, app, version)
       submission_information = options[:submission_information] || {}
-      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
+      submission_information = submission_information.transform_keys(&:to_sym)
 
       uses_idfa = submission_information[:add_id_info_uses_idfa]
 
@@ -163,7 +163,7 @@ module Deliver
 
     def update_submission_information(options, app)
       submission_information = options[:submission_information] || {}
-      submission_information = submission_information.collect { |k, v| [k.to_sym, v] }.to_h
+      submission_information = submission_information.transform_keys(&:to_sym)
 
       content_rights = submission_information[:content_rights_contains_third_party_content]
 

data/deliver/lib/deliver/upload_metadata.rb

@@ -1,5 +1,7 @@
+require 'fastlane_core'
+require 'spaceship'
+
 require_relative 'module'
-require_relative 'queue_worker'
 
 module Deliver
   # upload description, rating, etc.
@@ -80,7 +82,7 @@ module Deliver
     def upload(options)
       return if options[:skip_metadata]
 
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
 
@@ -95,7 +97,7 @@ module Deliver
         localised_options = LOCALISED_LIVE_VALUES
         non_localised_options = NON_LOCALISED_LIVE_VALUES
 
-        if v.nil?
+        if version.nil?
           UI.message("Couldn't find live version, editing the current version on App Store Connect instead")
           version = fetch_edit_app_store_version(app, platform)
           # we don't want to update the localised_options and non_localised_options
@@ -198,7 +200,7 @@ module Deliver
       sleep(1)
 
       # Update app store version localizations
-      store_version_worker = Deliver::QueueWorker.new do |app_store_version_localization|
+      store_version_worker = FastlaneCore::QueueWorker.new do |app_store_version_localization|
         attributes = localized_version_attributes_by_locale[app_store_version_localization.locale]
         if attributes
           UI.message("Uploading metadata to App Store Connect for localized version '#{app_store_version_localization.locale}'")
@@ -209,7 +211,7 @@ module Deliver
       store_version_worker.start
 
       # Update app info localizations
-      app_info_worker = Deliver::QueueWorker.new do |app_info_localization|
+      app_info_worker = FastlaneCore::QueueWorker.new do |app_info_localization|
         attributes = localized_info_attributes_by_locale[app_info_localization.locale]
         if attributes
           UI.message("Uploading metadata to App Store Connect for localized info '#{app_info_localization.locale}'")
@@ -340,7 +342,7 @@ module Deliver
 
       set_review_information(version, options)
       set_review_attachment_file(version, options)
-      set_app_rating(version, options)
+      set_app_rating(app_info, options)
     end
 
     # rubocop:enable Metrics/PerceivedComplexity
@@ -375,9 +377,7 @@ module Deliver
       # Check folder list (an empty folder signifies a language is required)
       ignore_validation = options[:ignore_language_directory_validation]
       Loader.language_folders(options[:metadata_path], ignore_validation).each do |lang_folder|
-        next unless File.directory?(lang_folder) # We don't want to read txt as they are non localised
-        language = File.basename(lang_folder)
-        enabled_languages << language unless enabled_languages.include?(language)
+        enabled_languages << lang_folder.basename unless enabled_languages.include?(lang_folder.basename)
       end
 
       return unless enabled_languages.include?("default")
@@ -416,10 +416,7 @@ module Deliver
       # Check folder list (an empty folder signifies a language is required)
       ignore_validation = options[:ignore_language_directory_validation]
       Loader.language_folders(options[:metadata_path], ignore_validation).each do |lang_folder|
-        next unless File.directory?(lang_folder) # We don't want to read txt as they are non localised
-
-        language = File.basename(lang_folder)
-        enabled_languages << language unless enabled_languages.include?(language)
+        enabled_languages << lang_folder.basename unless enabled_languages.include?(lang_folder.basename)
       end
 
       # Mapping to strings because :default symbol can be passed in
@@ -530,14 +527,13 @@ module Deliver
       # Load localised data
       ignore_validation = options[:ignore_language_directory_validation]
       Loader.language_folders(options[:metadata_path], ignore_validation).each do |lang_folder|
-        language = File.basename(lang_folder)
         (LOCALISED_VERSION_VALUES.keys + LOCALISED_APP_VALUES.keys).each do |key|
-          path = File.join(lang_folder, "#{key}.txt")
+          path = File.join(lang_folder.path, "#{key}.txt")
           next unless File.exist?(path)
 
           UI.message("Loading '#{path}'...")
           options[key] ||= {}
-          options[key][language] ||= File.read(path)
+          options[key][lang_folder.basename] ||= File.read(path)
         end
       end
 
@@ -596,9 +592,10 @@ module Deliver
     end
 
     def set_review_information(version, options)
-      return unless options[:app_review_information]
       info = options[:app_review_information]
-      info = info.collect { |k, v| [k.to_sym, v] }.to_h
+      return if info.nil? || info.empty?
+
+      info = info.transform_keys(&:to_sym)
       UI.user_error!("`app_review_information` must be a hash", show_github_issues: true) unless info.kind_of?(Hash)
 
       attributes = {}
@@ -645,7 +642,7 @@ module Deliver
       end
     end
 
-    def set_app_rating(version, options)
+    def set_app_rating(app_info, options)
       return unless options[:app_rating_config_path]
 
       require 'json'
@@ -678,9 +675,23 @@ module Deliver
         has_mapped_values = true
         UI.deprecated("Age rating '#{k}' from iTunesConnect has been deprecated. Please replace with '#{v}'")
       end
-      UI.deprecated("You can find more info at https://docs.fastlane.tools/actions/deliver/#reference") if has_mapped_values
 
-      age_rating_declaration = version.fetch_age_rating_declaration
+      # Handle App Store Connect deprecation/migrations of keys/values if possible
+      attributes, deprecation_messages, errors = Spaceship::ConnectAPI::AgeRatingDeclaration.map_deprecation_if_possible(attributes)
+      deprecation_messages.each do |message|
+        UI.deprecated(message)
+      end
+
+      unless errors.empty?
+        errors.each do |error|
+          UI.error(error)
+        end
+        UI.user_error!("There are Age Rating deprecation errors that cannot be solved automatically... Please apply any fixes and try again")
+      end
+
+      UI.deprecated("You can find more info at https://docs.fastlane.tools/actions/deliver/#reference") if has_mapped_values || !deprecation_messages.empty?
+
+      age_rating_declaration = app_info.fetch_age_rating_declaration
       age_rating_declaration.update(attributes: attributes)
     end
   end

data/deliver/lib/deliver/upload_price_tier.rb

@@ -9,7 +9,7 @@ module Deliver
 
       price_tier = options[:price_tier].to_s
 
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       attributes = {}
       territory_ids = []

data/deliver/lib/deliver/upload_screenshots.rb

@@ -1,23 +1,23 @@
+require 'fastlane_core'
 require 'spaceship/tunes/tunes'
 require 'digest/md5'
 
 require_relative 'app_screenshot'
 require_relative 'module'
 require_relative 'loader'
-require_relative 'queue_worker'
 require_relative 'app_screenshot_iterator'
 
 module Deliver
   # upload screenshots to App Store Connect
   class UploadScreenshots
-    DeleteScreenshotJob = Struct.new(:app_screenshot, :localization, :app_screenshot_set)
+    DeleteScreenshotSetJob = Struct.new(:app_screenshot_set, :localization)
     UploadScreenshotJob = Struct.new(:app_screenshot_set, :path)
 
     def upload(options, screenshots)
       return if options[:skip_screenshots]
       return if options[:edit_live]
 
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       version = app.get_edit_app_store_version(platform: platform)
@@ -67,12 +67,12 @@ module Deliver
     def delete_screenshots(localizations, screenshots_per_language, tries: 5)
       tries -= 1
 
-      worker = QueueWorker.new do |job|
+      worker = FastlaneCore::QueueWorker.new do |job|
         start_time = Time.now
-        target = "#{job.localization.locale} #{job.app_screenshot_set.screenshot_display_type} #{job.app_screenshot.id}"
+        target = "#{job.localization.locale} #{job.app_screenshot_set.screenshot_display_type}"
         begin
           UI.verbose("Deleting '#{target}'")
-          job.app_screenshot.delete!
+          job.app_screenshot_set.delete!
           UI.message("Deleted '#{target}' -  (#{Time.now - start_time} secs)")
         rescue => error
           UI.error("Failed to delete screenshot #{target} - (#{Time.now - start_time} secs)")
@@ -81,12 +81,12 @@ module Deliver
       end
 
       iterator = AppScreenshotIterator.new(localizations)
-      iterator.each_app_screenshot do |localization, app_screenshot_set, app_screenshot|
+      iterator.each_app_screenshot_set do |localization, app_screenshot_set|
         # Only delete screenshots if trying to upload
         next unless screenshots_per_language.keys.include?(localization.locale)
 
-        UI.verbose("Queued delete sceeenshot job for #{localization.locale} #{app_screenshot_set.screenshot_display_type} #{app_screenshot.id}")
-        worker.enqueue(DeleteScreenshotJob.new(app_screenshot, localization, app_screenshot_set))
+        UI.verbose("Queued delete sceeenshot set job for #{localization.locale} #{app_screenshot_set.screenshot_display_type}")
+        worker.enqueue(DeleteScreenshotSetJob.new(app_screenshot_set, localization))
       end
 
       worker.start
@@ -113,7 +113,7 @@ module Deliver
       tries -= 1
 
       # Upload screenshots
-      worker = QueueWorker.new do |job|
+      worker = FastlaneCore::QueueWorker.new do |job|
         begin
           UI.verbose("Uploading '#{job.path}'...")
           start_time = Time.now
@@ -231,12 +231,13 @@ module Deliver
     end
 
     def sort_screenshots(localizations)
+      require 'naturally'
       iterator = AppScreenshotIterator.new(localizations)
 
       # Re-order screenshots within app_screenshot_set
-      worker = QueueWorker.new do |app_screenshot_set|
+      worker = FastlaneCore::QueueWorker.new do |app_screenshot_set|
         original_ids = app_screenshot_set.app_screenshots.map(&:id)
-        sorted_ids = app_screenshot_set.app_screenshots.sort_by(&:file_name).map(&:id)
+        sorted_ids = Naturally.sort(app_screenshot_set.app_screenshots, by: :file_name).map(&:id)
         if original_ids != sorted_ids
           app_screenshot_set.reorder_screenshots(app_screenshot_ids: sorted_ids)
         end
@@ -251,70 +252,7 @@ module Deliver
 
     def collect_screenshots(options)
       return [] if options[:skip_screenshots]
-      return collect_screenshots_for_languages(options[:screenshots_path], options[:ignore_language_directory_validation])
-    end
-
-    def collect_screenshots_for_languages(path, ignore_validation)
-      screenshots = []
-      extensions = '{png,jpg,jpeg}'
-
-      available_languages = UploadScreenshots.available_languages.each_with_object({}) do |lang, lang_hash|
-        lang_hash[lang.downcase] = lang
-      end
-
-      Loader.language_folders(path, ignore_validation).each do |lng_folder|
-        language = File.basename(lng_folder)
-
-        # Check to see if we need to traverse multiple platforms or just a single platform
-        if language == Loader::APPLE_TV_DIR_NAME || language == Loader::IMESSAGE_DIR_NAME
-          screenshots.concat(collect_screenshots_for_languages(File.join(path, language), ignore_validation))
-          next
-        end
-
-        files = Dir.glob(File.join(lng_folder, "*.#{extensions}"), File::FNM_CASEFOLD).sort
-        next if files.count == 0
-
-        framed_screenshots_found = Dir.glob(File.join(lng_folder, "*_framed.#{extensions}"), File::FNM_CASEFOLD).count > 0
-
-        UI.important("Framed screenshots are detected! 🖼 Non-framed screenshot files may be skipped. 🏃") if framed_screenshots_found
-
-        language_dir_name = File.basename(lng_folder)
-
-        if available_languages[language_dir_name.downcase].nil?
-          UI.user_error!("#{language_dir_name} is not an available language. Please verify that your language codes are available in iTunesConnect. See https://developer.apple.com/library/content/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/AppStoreTerritories.html for more information.")
-        end
-
-        language = available_languages[language_dir_name.downcase]
-
-        files.each do |file_path|
-          is_framed = file_path.downcase.include?("_framed.")
-          is_watch = file_path.downcase.include?("watch")
-
-          if framed_screenshots_found && !is_framed && !is_watch
-            UI.important("🏃 Skipping screenshot file: #{file_path}")
-            next
-          end
-
-          screenshots << AppScreenshot.new(file_path, language)
-        end
-      end
-
-      # Checking if the device type exists in spaceship
-      # Ex: iPhone 6.1 inch isn't supported in App Store Connect but need
-      # to have it in there for frameit support
-      unaccepted_device_shown = false
-      screenshots.select! do |screenshot|
-        exists = !screenshot.device_type.nil?
-        unless exists
-          UI.important("Unaccepted device screenshots are detected! 🚫 Screenshot file will be skipped. 🏃") unless unaccepted_device_shown
-          unaccepted_device_shown = true
-
-          UI.important("🏃 Skipping screenshot file: #{screenshot.path} - Not an accepted App Store Connect device...")
-        end
-        exists
-      end
-
-      return screenshots
+      return Loader.load_app_screenshots(options[:screenshots_path], options[:ignore_language_directory_validation])
     end
 
     # helper method so Spaceship::Tunes.client.available_languages is easier to test

data/fastlane/lib/fastlane/actions/actions_helper.rb

@@ -5,7 +5,7 @@ module Fastlane
       PLATFORM_NAME = :PLATFORM_NAME
       ENVIRONMENT = :ENVIRONMENT
 
-      # A slighly decorated hash that will store and fetch sensitive data
+      # A slightly decorated hash that will store and fetch sensitive data
       # but not display it while iterating keys and values
       class LaneContextValues < Hash
         def initialize
@@ -87,13 +87,13 @@ module Fastlane
     end
 
     # returns a list of official integrations
-    # rubocop:disable Style/AccessorMethodName
+    # rubocop:disable Naming/AccessorMethodName
     def self.get_all_official_actions
       Dir[File.expand_path('*.rb', File.dirname(__FILE__))].collect do |file|
         File.basename(file).gsub('.rb', '').to_sym
       end
     end
-    # rubocop:enable Style/AccessorMethodName
+    # rubocop:enable Naming/AccessorMethodName
 
     # Returns the class ref to the action based on the action name
     # Returns nil if the action is not available

data/fastlane/lib/fastlane/actions/adb.rb

@@ -27,18 +27,15 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :serial,
                                        env_name: "FL_ANDROID_SERIAL",
                                        description: "Android serial of the device to use for this command",
-                                       is_string: true,
                                        default_value: ""),
           FastlaneCore::ConfigItem.new(key: :command,
                                        env_name: "FL_ADB_COMMAND",
                                        description: "All commands you want to pass to the adb command, e.g. `kill-server`",
-                                       optional: true,
-                                       is_string: true),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :adb_path,
                                        env_name: "FL_ADB_PATH",
                                        optional: true,
-                                       description: "The path to your `adb` binary (can be left blank if the ANDROID_SDK_ROOT environment variable is set)",
-                                       is_string: true,
+                                       description: "The path to your `adb` binary (can be left blank if the ANDROID_SDK_ROOT, ANDROID_HOME or ANDROID_SDK environment variable is set)",
                                        default_value: "adb")
         ]
       end

data/fastlane/lib/fastlane/actions/adb_devices.rb

@@ -27,7 +27,6 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :adb_path,
                                        env_name: "FL_ADB_PATH",
                                        description: "The path to your `adb` binary (can be left blank if the ANDROID_SDK_ROOT environment variable is set)",
-                                       is_string: true,
                                        optional: true,
                                        default_value: "adb")
         ]

data/fastlane/lib/fastlane/actions/add_git_tag.rb

@@ -6,7 +6,16 @@ module Fastlane
         # lane name in lane_context could be nil because you can just call $fastlane add_git_tag which has no context
         lane_name = Actions.lane_context[Actions::SharedValues::LANE_NAME].to_s.delete(' ') # no spaces allowed
 
-        tag = options[:tag] || "#{options[:grouping]}/#{lane_name}/#{options[:prefix]}#{options[:build_number]}#{options[:postfix]}"
+        if options[:tag]
+          tag = options[:tag]
+        elsif options[:build_number]
+          tag_components = [options[:grouping]]
+          tag_components << lane_name if options[:includes_lane]
+          tag_components << "#{options[:prefix]}#{options[:build_number]}#{options[:postfix]}"
+          tag = tag_components.join('/')
+        else
+          UI.user_error!("No value found for 'tag' or 'build_number'. At least one of them must be provided. Note that if you do specify a tag, all other arguments are ignored.")
+        end
         message = options[:message] || "#{tag} (fastlane)"
 
         cmd = ['git tag']
@@ -28,14 +37,14 @@ module Fastlane
       def self.details
         list = <<-LIST.markdown_list
           `grouping` is just to keep your tags organised under one 'folder', defaults to 'builds'
-          `lane` is the name of the current fastlane lane
+          `lane` is the name of the current fastlane lane, if chosen to be included via 'includes_lane' option, which defaults to 'true'
           `prefix` is anything you want to stick in front of the version number, e.g. 'v'
           `postfix` is anything you want to stick at the end of the version number, e.g. '-RC1'
           `build_number` is the build number, which defaults to the value emitted by the `increment_build_number` action
         LIST
 
         [
-          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number>`, where:".markdown_preserve_newlines,
+          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number><postfix>`, where:".markdown_preserve_newlines,
           list,
           "For example, for build 1234 in the 'appstore' lane, it will tag the commit with `builds/appstore/1234`."
         ].join("\n")
@@ -51,6 +60,11 @@ module Fastlane
                                        env_name: "FL_GIT_TAG_GROUPING",
                                        description: "Is used to keep your tags organised under one 'folder'",
                                        default_value: 'builds'),
+          FastlaneCore::ConfigItem.new(key: :includes_lane,
+                                       env_name: "FL_GIT_TAG_INCLUDES_LANE",
+                                       description: "Whether the current lane should be included in the tag and message composition, e.g. '<grouping>/<lane>/<prefix><build_number><postfix>'",
+                                       type: Boolean,
+                                       default_value: true),
           FastlaneCore::ConfigItem.new(key: :prefix,
                                        env_name: "FL_GIT_TAG_PREFIX",
                                        description: "Anything you want to put in front of the version number (e.g. 'v')",
@@ -64,7 +78,8 @@ module Fastlane
                                        description: "The build number. Defaults to the result of increment_build_number if you\'re using it",
                                        default_value: Actions.lane_context[Actions::SharedValues::BUILD_NUMBER],
                                        default_value_dynamic: true,
-                                       is_string: false),
+                                       skip_type_validation: true, # skipping validation because we both allow integer and string
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :message,
                                        env_name: "FL_GIT_TAG_MESSAGE",
                                        description: "The tag message. Defaults to the tag's name",
@@ -79,13 +94,13 @@ module Fastlane
                                        env_name: "FL_GIT_TAG_FORCE",
                                        description: "Force adding the tag",
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :sign,
                                        env_name: "FL_GIT_TAG_SIGN",
                                        description: "Make a GPG-signed tag, using the default e-mail address's key",
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false)
         ]
       end
@@ -95,6 +110,7 @@ module Fastlane
           'add_git_tag # simple tag with default values',
           'add_git_tag(
             grouping: "fastlane-builds",
+            includes_lane: true,
             prefix: "v",
             postfix: "-RC1",
             build_number: 123