fastlane 2.196.0 → 2.212.2

data/deliver/lib/deliver/runner.rb

@@ -46,6 +46,12 @@ module Deliver
     end
 
     def run
+      if options[:verify_only]
+        UI.important("Verify flag is set, only package validation will take place and no submission will be made")
+        verify_binary
+        return
+      end
+
       verify_version if options[:app_version].to_s.length > 0 && !options[:skip_app_version_update]
 
       # Rejecting before upload meta
@@ -155,39 +161,74 @@ module Deliver
       UploadPriceTier.new.upload(options)
     end
 
+    # Verify the binary with App Store Connect
+    def verify_binary
+      UI.message("Verifying binary with App Store Connect")
+
+      ipa_path = options[:ipa]
+      pkg_path = options[:pkg]
+
+      platform = options[:platform]
+      transporter = transporter_for_selected_team
+
+      case platform
+      when "ios", "appletvos"
+        package_path = FastlaneCore::IpaUploadPackageBuilder.new.generate(
+          app_id: Deliver.cache[:app].id,
+          ipa_path: ipa_path,
+          package_path: "/tmp",
+          platform: platform
+        )
+        result = transporter.verify(package_path: package_path, asset_path: ipa_path, platform: platform)
+      when "osx"
+        package_path = FastlaneCore::PkgUploadPackageBuilder.new.generate(
+          app_id: Deliver.cache[:app].id,
+          pkg_path: pkg_path,
+          package_path: "/tmp",
+          platform: platform
+        )
+        result = transporter.verify(package_path: package_path, asset_path: pkg_path, platform: platform)
+      else
+        UI.user_error!("No suitable file found for verify for platform: #{options[:platform]}")
+      end
+
+      unless result
+        transporter_errors = transporter.displayable_errors
+        UI.user_error!("Error verifying the binary file: \n #{transporter_errors}")
+      end
+    end
+
     # Upload the binary to App Store Connect
     def upload_binary
       UI.message("Uploading binary to App Store Connect")
 
-      upload_ipa = options[:ipa]
-      upload_pkg = options[:pkg]
+      ipa_path = options[:ipa]
+      pkg_path = options[:pkg]
 
-      # 2020-01-27
-      # Only verify platform if if both ipa and pkg exists (for backwards support)
-      if upload_ipa && upload_pkg
-        upload_ipa = ["ios", "appletvos"].include?(options[:platform])
-        upload_pkg = options[:platform] == "osx"
-      end
+      platform = options[:platform]
+      transporter = transporter_for_selected_team
 
-      if upload_ipa
+      case platform
+      when "ios", "appletvos"
         package_path = FastlaneCore::IpaUploadPackageBuilder.new.generate(
           app_id: Deliver.cache[:app].id,
-          ipa_path: options[:ipa],
+          ipa_path: ipa_path,
           package_path: "/tmp",
-          platform: options[:platform]
+          platform: platform
         )
-      elsif upload_pkg
+        result = transporter.upload(package_path: package_path, asset_path: ipa_path, platform: platform)
+      when "osx"
         package_path = FastlaneCore::PkgUploadPackageBuilder.new.generate(
           app_id: Deliver.cache[:app].id,
-          pkg_path: options[:pkg],
+          pkg_path: pkg_path,
           package_path: "/tmp",
-          platform: options[:platform]
+          platform: platform
         )
+        result = transporter.upload(package_path: package_path, asset_path: pkg_path, platform: platform)
+      else
+        UI.user_error!("No suitable file found for upload for platform: #{options[:platform]}")
       end
 
-      transporter = transporter_for_selected_team
-      result = transporter.upload(package_path: package_path)
-
       unless result
         transporter_errors = transporter.displayable_errors
         UI.user_error!("Error uploading ipa file: \n #{transporter_errors}")
@@ -197,8 +238,21 @@ module Deliver
     def reject_version_if_possible
       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!")
+
+      submission = app.get_in_progress_review_submission(platform: platform)
+      if submission
+        submission.cancel_submission
+        UI.message("Review submission cancellation has been requested")
+
+        # An app version won't get removed from review instantly
+        # Polling until there is no longer an in-progress version
+        loop do
+          break if app.get_in_progress_review_submission(platform: platform).nil?
+          UI.message("Waiting for cancellation to take effect...")
+          sleep(15)
+        end
+
+        UI.success("Successfully cancelled previous submission!")
       end
     end
 
@@ -215,22 +269,32 @@ module Deliver
     def transporter_for_selected_team
       # Use JWT auth
       api_token = Spaceship::ConnectAPI.token
+      api_key = if options[:api_key].nil? && !api_token.nil?
+                  # Load api key info if user set api_key_path, not api_key
+                  { key_id: api_token.key_id, issuer_id: api_token.issuer_id, key: api_token.key_raw }
+                elsif !options[:api_key].nil?
+                  api_key = options[:api_key].transform_keys(&:to_sym).dup
+                  # key is still base 64 style if api_key is loaded from option
+                  api_key[:key] = Base64.decode64(api_key[:key]) if api_key[:is_key_content_base64]
+                  api_key
+                end
+
       unless api_token.nil?
         api_token.refresh! if api_token.expired?
-        return FastlaneCore::ItunesTransporter.new(nil, nil, false, nil, api_token.text)
+        return FastlaneCore::ItunesTransporter.new(nil, nil, false, nil, api_token.text, altool_compatible_command: true, api_key: api_key)
       end
 
       tunes_client = Spaceship::ConnectAPI.client.tunes_client
 
-      generic_transporter = FastlaneCore::ItunesTransporter.new(options[:username], nil, false, options[:itc_provider])
+      generic_transporter = FastlaneCore::ItunesTransporter.new(options[:username], nil, false, options[:itc_provider], altool_compatible_command: true, api_key: api_key)
       return generic_transporter unless options[:itc_provider].nil? && tunes_client.teams.count > 1
 
       begin
-        team = tunes_client.teams.find { |t| t['contentProvider']['contentProviderId'].to_s == tunes_client.team_id }
-        name = team['contentProvider']['name']
+        team = tunes_client.teams.find { |t| t['providerId'].to_s == tunes_client.team_id }
+        name = team['name']
         provider_id = generic_transporter.provider_ids[name]
         UI.verbose("Inferred provider id #{provider_id} for team #{name}.")
-        return FastlaneCore::ItunesTransporter.new(options[:username], nil, false, provider_id)
+        return FastlaneCore::ItunesTransporter.new(options[:username], nil, false, provider_id, altool_compatible_command: true, api_key: api_key)
       rescue => ex
         UI.verbose("Couldn't infer a provider short name for team with id #{tunes_client.team_id} automatically: #{ex}. Proceeding without provider short name.")
         return generic_transporter

data/deliver/lib/deliver/submit_for_review.rb

@@ -23,12 +23,34 @@ module Deliver
       update_idfa(options, app, version)
       update_submission_information(options, app)
 
-      version.create_app_store_version_submission
-
+      create_review_submission(options, app, version, platform)
       UI.success("Successfully submitted the app for review!")
     end
 
-    private def select_build(options, app, version, platform)
+    private
+
+    def create_review_submission(options, app, version, platform)
+      # Can't submit a review if there is already a review in progress
+      if app.get_in_progress_review_submission(platform: platform)
+        UI.user_error!("Cannot submit for review - A review submission is already in progress")
+      end
+
+      # There can only be one open submission per platform per app
+      # There might be a submission already created so we need to check
+      # 1. Create the submission if its not already created
+      # 2. Error if submission already contains some items for review (because we don't know what they are)
+      submission = app.get_ready_review_submission(platform: platform, includes: "items")
+      if submission.nil?
+        submission = app.create_review_submission(platform: platform)
+      elsif !submission.items.empty?
+        UI.user_error!("Cannot submit for review - A review submission already exists with items not managed by fastlane. Please cancel or remove items from submission for the App Store Connect website")
+      end
+
+      submission.add_app_store_version_to_review_items(app_store_version_id: version.id)
+      submission.submit_for_review
+    end
+
+    def select_build(options, app, version, platform)
       if options[:build_number] && options[:build_number] != "latest"
         UI.message("Selecting existing build-number: #{options[:build_number]}")
 

data/deliver/lib/deliver/upload_price_tier.rb

@@ -12,7 +12,9 @@ module Deliver
       app = Deliver.cache[:app]
 
       attributes = {}
-      territory_ids = []
+
+      # Check App update method to understand how to use territory_ids.
+      territory_ids = nil # nil won't update app's territory_ids, empty array would remove app from sale.
 
       # As of 2020-09-14:
       # Official App Store Connect does not have an endpoint to get app prices for an app

data/deliver/lib/deliver/upload_screenshots.rb

@@ -145,7 +145,7 @@ module Deliver
         if duplicate
           UI.message("Previous uploaded. Skipping '#{screenshot.path}'...")
         else
-          UI.verbose("Queued uplaod sceeenshot job for #{localization.locale} #{app_screenshot_set.screenshot_display_type} #{screenshot.path}")
+          UI.verbose("Queued upload sceeenshot job for #{localization.locale} #{app_screenshot_set.screenshot_display_type} #{screenshot.path}")
           worker.enqueue(UploadScreenshotJob.new(app_screenshot_set, screenshot.path))
           number_of_screenshots_per_set[app_screenshot_set] += 1
         end
@@ -157,7 +157,7 @@ module Deliver
 
       UI.verbose('Uploading jobs are completed')
 
-      Helper.show_loading_indicator("Waiting for all the screenshots processed...")
+      Helper.show_loading_indicator("Waiting for all the screenshots to finish being processed...")
       states = wait_for_complete(iterator)
       Helper.hide_loading_indicator
       retry_upload_screenshots_if_needed(iterator, states, total_number_of_screenshots, tries, localizations, screenshots_per_language)

data/fastlane/lib/assets/AppfileTemplate

@@ -1,5 +1,5 @@
 # app_identifier("[[APP_IDENTIFIER]]") # The bundle identifier of your app
-# apple_id("[[APPLE_ID]]") # Your Apple email address
+# apple_id("[[APPLE_ID]]") # Your Apple Developer Portal username
 
 [[TEAMS]]
 # For more information about the Appfile, see:

data/fastlane/lib/assets/AppfileTemplate.swift

@@ -1,5 +1,5 @@
 var appIdentifier: String { return "[[APP_IDENTIFIER]]" } // The bundle identifier of your app
-var appleID: String { return "[[APPLE_ID]]" } // Your Apple email address
+var appleID: String { return "[[APPLE_ID]]" } // Your Apple Developer Portal username
 
 [[TEAMS]]
 

data/fastlane/lib/fastlane/actions/badge.rb

@@ -63,7 +63,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :dark,
                                        env_name: "FL_BADGE_DARK",
-                                       description: "Adds a dark flavored badge ontop of your icon",
+                                       description: "Adds a dark flavored badge on top of your icon",
                                        optional: true,
                                        type: Boolean,
                                        verify_block: proc do |value|

data/fastlane/lib/fastlane/actions/changelog_from_git_commits.rb

@@ -141,7 +141,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :merge_commit_filtering,
                                        env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_MERGE_COMMIT_FILTERING',
-                                       description: "Controls inclusion of merge commits when collecting the changelog. Valid values: #{GIT_MERGE_COMMIT_FILTERING_OPTIONS.map { |o| "`:#{o}`" }.join(', ')}",
+                                       description: "Controls inclusion of merge commits when collecting the changelog. Valid values: #{GIT_MERGE_COMMIT_FILTERING_OPTIONS.map { |o| "'#{o}'" }.join(', ')}",
                                        optional: true,
                                        default_value: 'include_merges',
                                        verify_block: proc do |value|

data/fastlane/lib/fastlane/actions/danger.rb

@@ -25,6 +25,8 @@ module Fastlane
         cmd << "pr #{pr}" if pr
 
         ENV['DANGER_GITHUB_API_TOKEN'] = params[:github_api_token] if params[:github_api_token]
+        ENV['DANGER_GITHUB_HOST'] = params[:github_enterprise_host] if params[:github_enterprise_host]
+        ENV['DANGER_GITHUB_API_BASE_URL'] = params[:github_enterprise_api_base_url] if params[:github_enterprise_api_base_url]
 
         Actions.sh(cmd.join(' '))
       end
@@ -66,6 +68,18 @@ module Fastlane
                                        sensitive: true,
                                        code_gen_sensitive: true,
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :github_enterprise_host,
+                                       env_name: "FL_DANGER_GITHUB_ENTERPRISE_HOST",
+                                       description: "GitHub host URL for GitHub Enterprise",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :github_enterprise_api_base_url,
+                                       env_name: "FL_DANGER_GITHUB_ENTERPRISE_API_BASE_URL",
+                                       description: "GitHub API base URL for GitHub Enterprise",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :fail_on_errors,
                                        env_name: "FL_DANGER_FAIL_ON_ERRORS",
                                        description: "Should always fail the build process, defaults to false",

data/fastlane/lib/fastlane/actions/docs/build_app.md

@@ -74,7 +74,7 @@ That's all you need to build your application. If you want more control, here ar
 fastlane gym --workspace "Example.xcworkspace" --scheme "AppName" --clean
 ```
 
-If you need to use a different Xcode installation, use `xcode-select` or define `DEVELOPER_DIR`:
+If you need to use a different Xcode installation, use `[xcodes](https://docs.fastlane.tools/actions/xcodes)` or define `DEVELOPER_DIR`:
 
 ```no-highlight
 DEVELOPER_DIR="/Applications/Xcode6.2.app" fastlane gym
@@ -150,7 +150,7 @@ build_app(
   scheme: "Release",
   export_method: "app-store",
   export_options: {
-    provisioningProfiles: { 
+    provisioningProfiles: {
       "com.example.bundleid" => "Provisioning Profile Name",
       "com.example.bundleid2" => "Provisioning Profile Name 2"
     }
@@ -184,10 +184,10 @@ end
 error do |lane, exception|
   slack(
     # message with short human friendly message
-    message: exception.to_s, 
-    success: false, 
+    message: exception.to_s,
+    success: false,
     # Output containing extended log output
-    payload: { "Output" => exception.error_info.to_s } 
+    payload: { "Output" => exception.error_info.to_s }
   )
 end
 ```

data/fastlane/lib/fastlane/actions/docs/capture_android_screenshots.md

@@ -25,6 +25,7 @@ gem install fastlane
 ```
 
 ##### Gradle dependency
+
 ```java
 androidTestImplementation 'tools.fastlane:screengrab:x.x.x'
 ```
@@ -60,17 +61,23 @@ Ensure that the following permissions exist in your **src/debug/AndroidManifest.
 ##### Configuring your <a href="#ui-tests">UI Tests</a> for Screenshots
 
 1. Add `LocaleTestRule` to your tests class to handle automatic switching of locales.
+
    If you're using Java use:
+   
    ```java
    @ClassRule
    public static final LocaleTestRule localeTestRule = new LocaleTestRule();
    ```
+   
    If you're using Kotlin use:
+   
    ```kotlin
    @Rule @JvmField
    val localeTestRule = LocaleTestRule()
    ```
+   
    The `@JvmField` annotation is important. It won't work like this:
+   
    ```kotlin
    companion object {
        @get:ClassRule
@@ -84,6 +91,7 @@ Ensure that the following permissions exist in your **src/debug/AndroidManifest.
 - Then, before running `fastlane screengrab` you'll need a debug and test apk
   - You can create your APKs manually with `./gradlew assembleDebug assembleAndroidTest`
   - You can also create a lane and use `build_android_app`:
+
     ```ruby
     desc "Build debug and test APK for screenshots"
     lane :build_and_screengrab do
@@ -163,7 +171,9 @@ fastlane action screengrab
 Check out [Testing UI for a Single App](http://developer.android.com/training/testing/ui-testing/espresso-testing.html) for an introduction to using Espresso for UI testing.
 
 ##### Example UI Test Class (Using JUnit4)
+
 Java:
+
 ```java
 @RunWith(JUnit4.class)
 public class JUnit4StyleTests {
@@ -182,9 +192,10 @@ public class JUnit4StyleTests {
         Screengrab.screenshot("after_button_click");
     }
 }
-
 ```
+
 Kotlin:
+
 ```kotlin
 @RunWith(JUnit4.class)
 class JUnit4StyleTests {
@@ -203,7 +214,6 @@ class JUnit4StyleTests {
         Screengrab.screenshot("after_button_click")
     }
 }
-
 ```
 
 There is an [example project](https://github.com/fastlane/fastlane/tree/master/screengrab/example/src/androidTest/java/tools/fastlane/localetester) showing how to use JUnit 3 or 4 and Espresso with the screengrab Java library to capture screenshots during a UI test run.
@@ -224,6 +234,7 @@ Note: the clean status bar feature is only supported on devices with *API level
 
 You can enable and disable the clean status bar at any moment during your tests.
 In most cases you probably want to do this in the @BeforeClass and @AfterClass methods.
+
 ```java
 @BeforeClass
 public static void beforeAll() {
@@ -238,6 +249,7 @@ public static void afterAll() {
 
 Have a look at the methods of the `CleanStatusBar` class to customize the status bar even more.
 You could for example show the Bluetooth icon and the LTE text.
+
 ```java
 new CleanStatusBar()
     .setBluetoothState(BluetoothState.DISCONNECTED)
@@ -283,6 +295,7 @@ if (extras != null) {
 For some apps, it is helpful to know when _screengrab_ is running so that you can display specific data for your screenshots. For iOS fastlane users, this is much like "FASTLANE_SNAPSHOT". In order to do this, you'll need to have at least two product flavors of your app.
 
 Add two product flavors to the app-level build.gradle file:
+
 ```
 android {
 ...
@@ -300,6 +313,7 @@ android {
 ```
 
 Check for the existence of that flavor (i.e screengrab) in your app code as follows in order to use mock data or customize data for screenshots:
+
 ```
 if (BuildConfig.FLAVOR == "screengrab") {
     System.out.println("screengrab is running!");
@@ -307,14 +321,17 @@ if (BuildConfig.FLAVOR == "screengrab") {
 ```
 
 When running _screengrab_, do the following to build the flavor you want as well as the test apk. Note that you use "assembleFlavor_name" where Flavor_name is the flavor name, capitalized (i.e. Screengrab).
+
 ```
 ./gradlew assembleScreengrab assembleAndroidTest
 ```
 
 Run _screengrab_:
+
 ```
 fastlane screengrab
 ```
+
 _screengrab_ will ask you to select the debug and test apps (which you can then add to your Screengrabfile to skip this step later).
 
 The debug apk should be somewhere like this:

data/fastlane/lib/fastlane/actions/docs/frame_screenshots.md

@@ -60,7 +60,7 @@ Here is a nice gif, that shows _frameit_ in action:
 <h5 align="center">The <em>frameit</em> 2.0 update was kindly sponsored by <a href="https://mindnode.com/">MindNode</a>, seen in the screenshots above.</h5>
 
 
-The first time that _frameit_ is executed the frames will be downloaded automatically. Originally the frames are coming from [Facebook frameset](http://facebook.design/devices) and they are kept on [this repo](https://github.com/fastlane/frameit-frames).
+The first time that _frameit_ is executed the frames will be downloaded automatically. Originally the frames are coming from [Facebook frameset](https://design.facebook.com/toolsandresources/devices/) and they are kept on [this repo](https://github.com/fastlane/frameit-frames).
 
 More information about this process and how to update the frames can be found [here](https://github.com/fastlane/fastlane/tree/master/frameit/frames_generator)
 

data/fastlane/lib/fastlane/actions/docs/run_tests.md

@@ -100,7 +100,7 @@ That's all you need to run your tests. If you want more control, here are some a
 fastlane scan --workspace "Example.xcworkspace" --scheme "AppName" --device "iPhone 6" --clean
 ```
 
-If you need to use a different Xcode install, use `xcode-select` or define `DEVELOPER_DIR`:
+If you need to use a different Xcode install, use `[xcodes](https://docs.fastlane.tools/actions/xcodes)` or define `DEVELOPER_DIR`:
 
 ```no-highlight
 DEVELOPER_DIR="/Applications/Xcode6.2.app" scan

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

@@ -694,7 +694,7 @@ In this case, default values for keywords, urls, name and release notes are used
 
 [Starting March 20, 2019 Apple's App Store](https://developer.apple.com/news/?id=03202019a) requires 12.9-inch iPad Pro (3rd generation) screenshots additionally to the iPad Pro 2nd generation [screenshots](https://help.apple.com/app-store-connect/#/devd274dd925). As fastlane historically uses the screenshot dimensions to determine the "display family" of a screenshot, this poses a problem as both use the same dimensions and are recognized as the same device family.
 
-To solve this a screenshot of a 12.9-inch iPad Pro (3rd generation) must contain either the string `iPad Pro (12.9-inch) (3rd generation)` or `ipadPro129` (Apple's internal naming of the display family for the 3rd generation iPad Pro) in its filename to be assigned the correct display family and to be uploaded to the correct screenshot slot in your app's metadata.
+To solve this a screenshot of a 12.9-inch iPad Pro (3rd generation) must contain either the string `iPad Pro (12.9-inch) (3rd generation)`, `IPAD_PRO_3GEN_129`, or `ipadPro129` (Apple's internal naming of the display family for the 3rd generation iPad Pro) in its filename to be assigned the correct display family and to be uploaded to the correct screenshot slot in your app's metadata.
 
 ## Automatically create screenshots