fastlane 2.183.0 → 2.185.0

data/deliver/lib/deliver/runner.rb

@@ -26,9 +26,11 @@ 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
@@ -42,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]
 
@@ -118,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)
@@ -167,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]
@@ -191,7 +187,7 @@ module Deliver
     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!")
@@ -210,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

@@ -39,7 +39,7 @@ 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)

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)

data/deliver/lib/deliver/upload_metadata.rb

@@ -82,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])
 
@@ -97,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
@@ -342,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
@@ -642,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'
@@ -675,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

@@ -17,7 +17,7 @@ module Deliver
       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)

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, ANDROID_HOME or ANDROID_SDK environment variable is set)",
-                                       is_string: true,
                                        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

@@ -63,7 +63,7 @@ module Fastlane
           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>'",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :prefix,
                                        env_name: "FL_GIT_TAG_PREFIX",
@@ -78,7 +78,7 @@ 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",
@@ -94,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

data/fastlane/lib/fastlane/actions/app_store_build_number.rb

@@ -27,10 +27,11 @@ module Fastlane
 
       def self.get_build_number(params)
         # Prompts select team if multiple teams and none specified
-        token = self.api_token(params)
-        if token
-          UI.message("Using App Store Connect API token...")
-          Spaceship::ConnectAPI.token = token
+        if (api_token = Spaceship::ConnectAPI::Token.from(hash: params[:api_key], filepath: params[: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
@@ -102,13 +103,6 @@ module Fastlane
         versions.map(&:to_s).sort_by { |v| Gem::Version.new(v) }
       end
 
-      def self.api_token(params)
-        params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
-        api_token ||= Spaceship::ConnectAPI::Token.create(**params[:api_key]) if params[:api_key]
-        api_token ||= Spaceship::ConnectAPI::Token.from_json_file(params[:api_key_path]) if params[:api_key_path]
-        return api_token
-      end
-
       #####################################################
       # @!group Documentation
       #####################################################
@@ -133,13 +127,15 @@ module Fastlane
                                        env_names: ["APPSTORE_BUILD_NUMBER_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,
+                                       default_value: Fastlane::Actions.lane_context[Fastlane::Actions::SharedValues::APP_STORE_CONNECT_API_KEY],
+                                       default_value_dynamic: true,
                                        optional: true,
                                        sensitive: true,
                                        conflicting_options: [:api_key_path]),
           FastlaneCore::ConfigItem.new(key: :initial_build_number,
                                        env_name: "INITIAL_BUILD_NUMBER",
                                        description: "sets the build number to given value if no build is in current train",
-                                       is_string: false),
+                                       skip_type_validation: true), # as we also allow integers, which we convert to strings anyway
           FastlaneCore::ConfigItem.new(key: :app_identifier,
                                        short_option: "-a",
                                        env_name: "FASTLANE_APP_IDENTIFIER",
@@ -159,7 +155,7 @@ module Fastlane
                                        env_name: "APPSTORE_BUILD_NUMBER_LIVE_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,
@@ -171,7 +167,7 @@ module Fastlane
                                        env_name: "APPSTORE_BUILD_NUMBER_LIVE",
                                        description: "Query the live version (ready-for-sale)",
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :version,
                                        env_name: "LATEST_VERSION",
@@ -182,7 +178,6 @@ module Fastlane
                                        env_name: "APPSTORE_PLATFORM",
                                        description: "The platform to use (optional)",
                                        optional: true,
-                                       is_string: true,
                                        default_value: "ios",
                                        verify_block: proc do |value|
                                          UI.user_error!("The platform can only be ios, appletvos, or osx") unless %('ios', 'appletvos', 'osx').include?(value)

data/fastlane/lib/fastlane/actions/app_store_connect_api_key.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'spaceship'
 
 module Fastlane
   module Actions
@@ -37,6 +38,10 @@ module Fastlane
 
         Actions.lane_context.set_sensitive(SharedValues::APP_STORE_CONNECT_API_KEY, key)
 
+        # Creates Spaceship API Key session
+        # User does not need to pass the token into any actions because of this
+        Spaceship::ConnectAPI.token = Spaceship::ConnectAPI::Token.create(**key) if options[:set_spaceship_token]
+
         return key
       end
 
@@ -83,8 +88,13 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :in_house,
                                        env_name: "APP_STORE_CONNECT_API_KEY_IN_HOUSE",
                                        description: "Is App Store or Enterprise (in house) team? App Store Connect API cannot determine this on its own (yet)",
-                                       optional: true,
-                                       type: Boolean)
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :set_spaceship_token,
+                                       env_name: "APP_STORE_CONNECT_API_KEY_SET_SPACESHIP_TOKEN",
+                                       description: "Authorizes all Spaceship::ConnectAPI requests by automatically setting Spaceship::ConnectAPI.token",
+                                       type: Boolean,
+                                       default_value: true)
         ]
       end
 

data/fastlane/lib/fastlane/actions/appetize_viewing_url_generator.rb

@@ -50,7 +50,6 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :public_key,
                                        env_name: "APPETIZE_PUBLICKEY",
                                        description: "Public key of the app you wish to update",
-                                       is_string: true,
                                        sensitive: true,
                                        default_value: Actions.lane_context[SharedValues::APPETIZE_PUBLIC_KEY],
                                        default_value_dynamic: true,
@@ -63,18 +62,15 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :base_url,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_BASE",
                                        description: "Base URL of Appetize service",
-                                       is_string: true,
                                        default_value: "https://appetize.io/embed",
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :device,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_DEVICE",
                                        description: "Device type: iphone4s, iphone5s, iphone6, iphone6plus, ipadair, iphone6s, iphone6splus, ipadair2, nexus5, nexus7 or nexus9",
-                                       is_string: true,
                                        default_value: "iphone5s"),
           FastlaneCore::ConfigItem.new(key: :scale,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_SCALE",
                                        description: "Scale of the simulator",
-                                       is_string: true,
                                        optional: true,
                                        verify_block: proc do |value|
                                          available = ["25", "50", "75", "100"]
@@ -83,7 +79,6 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :orientation,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_ORIENTATION",
                                        description: "Device orientation",
-                                       is_string: true,
                                        default_value: "portrait",
                                        verify_block: proc do |value|
                                          available = ["portrait", "landscape"]
@@ -92,12 +87,10 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :language,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_LANGUAGE",
                                        description: "Device language in ISO 639-1 language code, e.g. 'de'",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :color,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_COLOR",
                                        description: "Color of the device",
-                                       is_string: true,
                                        default_value: "black",
                                        verify_block: proc do |value|
                                          available = ["black", "white", "silver", "gray"]
@@ -106,22 +99,18 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :launch_url,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_LAUNCH_URL",
                                        description: "Specify a deep link to open when your app is launched",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :os_version,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_OS_VERSION",
                                        description: "The operating system version on which to run your app, e.g. 10.3, 8.0",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :params,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_PARAMS",
                                        description: "Specify params value to be passed to Appetize",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :proxy,
                                        env_name: "APPETIZE_VIEWING_URL_GENERATOR_PROXY",
                                        description: "Specify a HTTP proxy to be passed to Appetize",
-                                       is_string: true,
                                        optional: true)
         ]
       end

data/fastlane/lib/fastlane/actions/carthage.rb

@@ -230,7 +230,7 @@ module Fastlane
             configuration: "Release",                       # Build configuration to use when building
             cache_builds: true,                             # By default Carthage will rebuild a dependency regardless of whether its the same resolved version as before.
             toolchain: "com.apple.dt.toolchain.Swift_2_3",  # Specify the xcodebuild toolchain
-            new_resolver: false,                            # Use the new resolver to resolve depdendency graph
+            new_resolver: false,                            # Use the new resolver to resolve dependency graph
             log_path: "carthage.log"                        # Path to the xcode build output
           )'
         ]

data/fastlane/lib/fastlane/actions/check_app_store_metadata.rb

@@ -5,9 +5,13 @@ module Fastlane
 
     class CheckAppStoreMetadataAction < Action
       def self.run(config)
+        # Only set :api_key from SharedValues if :api_key_path isn't set (conflicting options)
+        unless config[:api_key_path]
+          config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
+        end
+
         require 'precheck'
         Precheck.config = config
-        Precheck.config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
         return Precheck::Runner.new.run
       end
 

data/fastlane/lib/fastlane/actions/docs/upload_to_app_store.md.erb

@@ -288,7 +288,7 @@ reset_ratings(false)
 ##### app_rating_config_path
 You can set the app age ratings using _deliver_. You'll have to create and store a `JSON` configuration file. Copy the [template](https://github.com/fastlane/fastlane/blob/master/deliver/assets/example_rating_config.json) to your project folder and pass the path to the `JSON` file using the `app_rating_config_path` option.
 
-The keys/values on the top allow values from 0-2, and the items on the bottom allow only 0 or 1. More information in [#reference](#reference).
+The keys/values on the top allow one of 3 strings: "NONE", "INFREQUENT_OR_MILD" or "FREQUENT_OR_INTENSE", and the items on the bottom allow false or true. More information in [#reference](#reference).
 
 
 ## Metadata
@@ -591,9 +591,9 @@ Key | Editable While Live | Directory | Filename | Deprecated Filename
 
 **Values**
 
-- 0: None
-- 1: Infrequent/Mild
-- 2: Frequent/Intense
+- 0: None (Legacy value, use `NONE` instead)
+- 1: Infrequent/Mild (Legacy value, use `INFREQUENT_OR_MILD` instead)
+- 2: Frequent/Intense (Legacy value, use `FREQUENT_OR_INTENSE`instead)
 
 - `NONE`
 - `INFREQUENT_OR_MILD`
@@ -601,24 +601,43 @@ Key | Editable While Live | Directory | Filename | Deprecated Filename
 
 **Keys**
 
-- `violenceCartoonOrFantasy`
-- `violenceRealistic`
-- `violenceRealisticProlongedGraphicOrSadistic`
-- `profanityOrCrudeHumor`
-- `matureOrSuggestiveThemes`
-- `horrorOrFearThemes`
-- `medicalOrTreatmentInformation`
-- `alcoholTobaccoOrDrugUseOrReferences`
-- `gamblingSimulated`
-- `sexualContentOrNudity`
-- `sexualContentGraphicAndNudity`
+- 'alcoholTobaccoOrDrugUseOrReferences'
+- 'contests'
+- 'gamblingSimulated'
+- 'medicalOrTreatmentInformation'
+- 'profanityOrCrudeHumor'
+
+- 'sexualContentGraphicAndNudity'
+- 'sexualContentOrNudity'
+- 'horrorOrFearThemes'
+- 'matureOrSuggestiveThemes'
+- 'unrestrictedWebAccess'
+- 'violenceCartoonOrFantasy'
+- 'violenceRealisticProlongedGraphicOrSadistic'
+- 'violenceRealistic'
+- 'kidsAgeBand'
 
 #### Boolean
 
 **Keys**
 
+- `gambling`
+- 'seventeenPlus'
 - `unrestrictedWebAccess`
-- `gamblingAndContests`
+
+#### Kids Age
+
+**Values**
+
+- `FIVE_AND_UNDER`
+- `SIX_TO_EIGHT`
+- `NINE_TO_ELEVEN`
+- `null`
+
+**Keys**
+
+- `kidsAgeBand`
+
 </details>
 
 <br />