fastlane 2.138.0 → 2.143.0

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

@@ -73,7 +73,7 @@ fastlane match init
 
 <img src="/img/actions/match_init.gif" width="550" />
 
-You'll be asked if you want to store your code signing identities inside a **Git repo**, or on **Google Cloud**.
+You'll be asked if you want to store your code signing identities inside a **Git repo**, **Google Cloud** or **Amazon S3**.
 
 #### Git Storage
 
@@ -142,6 +142,18 @@ Example content (for more advanced setups check out the [fastlane section](#fast
 google_cloud_bucket_name("major-key-certificates")
 ```
 
+#### Amazon S3
+
+Use [Amazon S3](https://aws.amazon.com/s3/) for a fully hosted solution for your code signing identities. Certificates are stored on S3, inside a storage bucket you provide. You can also directly access the files using the web console.
+
+This will create a `Matchfile` in your current directory (or in your `./fastlane/` folder).
+
+Example content (for more advanced setups check out the [fastlane section](#fastlane)):
+
+```ruby-skip-tests
+s3_bucket("ios-certificates")
+```
+
 ### Multiple teams
 
 _match_ can store the codesigning files for multiple development teams:
@@ -155,9 +167,9 @@ match(git_branch: "team1", username: "user@team1.com")
 match(git_branch: "team2", username: "user@team2.com")
 ```
 
-#### Google Cloud Storage
+#### Google Cloud or Amazon S3 Storage
 
-If you use Google Cloud Storage, you don't need to do anything manually for multiple teams. Just use Google Cloud Storage, and the top level folder will be the team ID.
+If you use Google Cloud or Amazon S3 Storage, you don't need to do anything manually. Just use Google Cloud or Amazon S3 Storage, and the top level folder will be the team ID.
 
 ### Run
 
@@ -194,7 +206,7 @@ fastlane action match
 
 #### Handle multiple targets
 
-_match_ can use the same one Git repository or Google Cloud Storage for all bundle identifiers.
+_match_ can use the same one Git repository, Google Cloud, or Amazon S3 Storage for all bundle identifiers.
 
 If you have several targets with different bundle identifiers, supply them as a comma-separated list:
 
@@ -419,6 +431,10 @@ Once you've decided which approach to take, all that's left to do is to set your
 
 Accessing Google Cloud Storage from your CI system requires you to provide the `gc_keys.json` file as part of your build. How you implement this is your decision. You can inject that file during build time.
 
+#### Amazon S3 Storage access
+
+Accessing Amazon S3 Storage from your CI system requires you to provide the `s3_region`, `s3_access_key`, `s3_secret_access_key` and `s3_bucket` options (or environment variables), with keys that has read access to the bucket.
+
 ### Nuke
 
 If you never really cared about code signing and have a messy Apple Developer account with a lot of invalid, expired or Xcode managed profiles/certificates, you can use the `match nuke` command to revoke your certificates and provisioning profiles. Don't worry, apps that are already available in the App Store / TestFlight will still work. Builds distributed via Ad Hoc or Enterprise will be disabled after nuking your account, so you'll have to re-upload a new build. After clearing your account you'll start from a clean state, and you can run _match_ to generate your certificates and profiles again.

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

@@ -706,6 +706,16 @@ DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS="-t DAV" fastlane deliver
 ## HTTP Proxy
 iTunes Transporter is a Java application bundled with Xcode. In addition to utilizing the `DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS="-t DAV"`, you need to configure the transporter application to use the proxy independently from the system proxy or any environment proxy settings. You can find the configuration file within Xcode:
 
+**for Xcode11 and later**
+
+```no-highlight
+TOOLS_PATH=$( xcode-select -p )
+REL_PATH='../SharedFrameworks/ContentDeliveryServices.framework/Versions/A/itms/java/lib/net.properties'
+echo "$TOOLS_PATH/$REL_PATH"
+```
+
+**for Xcode10 or earlier**
+
 ```no-highlight
 TOOLS_PATH=$( xcode-select -p )
 REL_PATH='../Applications/Application Loader.app/Contents/itms/java/lib/net.properties'

data/fastlane/lib/fastlane/actions/ensure_git_branch.rb

@@ -34,7 +34,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :branch,
                                        env_name: "FL_ENSURE_GIT_BRANCH_NAME",
-                                       description: "The branch that should be checked for. String that can be either the full name of the branch or a regex to match",
+                                       description: "The branch that should be checked for. String that can be either the full name of the branch or a regex e.g. `^feature\/.*$` to match",
                                        is_string: true,
                                        default_value: 'master')
         ]

data/fastlane/lib/fastlane/actions/ensure_xcode_version.rb

@@ -4,6 +4,7 @@ module Fastlane
       def self.run(params)
         Actions.verify_gem!('xcode-install')
         required_version = params[:version]
+        strict = params[:strict]
 
         if required_version.to_s.length == 0
           # The user didn't provide an Xcode version, let's see
@@ -30,16 +31,38 @@ module Fastlane
           UI.user_error!("Invalid version number provided, make sure it's valid: #{ex}")
         end
 
-        if selected_version == required_version
-          UI.success("Selected Xcode version is correct: #{selected_version}")
+        if strict == true
+          if selected_version == required_version
+            success(selected_version)
+          else
+            error(selected_version, required_version)
+          end
         else
-          UI.message("Selected Xcode version is not correct: #{selected_version}. You expected #{required_version}.")
-          UI.message("To correct this, use: `xcode_select(version: #{required_version})`.")
+          required_version_numbers = required_version.to_s.split(".")
+          selected_version_numbers = selected_version.to_s.split(".")
+
+          required_version_numbers.each_with_index do |required_version_number, index|
+            selected_version_number = selected_version_numbers[index]
+            next unless required_version_number != selected_version_number
+            error(selected_version, required_version)
+            break
+          end
 
-          UI.user_error!("Selected Xcode version doesn't match your requirement.\nExpected: Xcode #{required_version}\nActual: Xcode #{selected_version}\n")
+          success(selected_version)
         end
       end
 
+      def self.success(selected_version)
+        UI.success("Selected Xcode version is correct: #{selected_version}")
+      end
+
+      def self.error(selected_version, required_version)
+        UI.message("Selected Xcode version is not correct: #{selected_version}. You expected #{required_version}.")
+        UI.message("To correct this, use: `xcode_select(version: #{required_version})`.")
+
+        UI.user_error!("Selected Xcode version doesn't match your requirement.\nExpected: Xcode #{required_version}\nActual: Xcode #{selected_version}\n")
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################
@@ -52,7 +75,8 @@ module Fastlane
         [
           "If building your app requires a specific version of Xcode, you can invoke this command before using gym.",
           "For example, to ensure that a beta version of Xcode is not accidentally selected to build, which would make uploading to TestFlight fail.",
-          "You can either manually provide a specific version using `version: ` or you make use of the `.xcode-version` file."
+          "You can either manually provide a specific version using `version: ` or you make use of the `.xcode-version` file.",
+          "Using the `strict` parameter, you can either verify the full set of version numbers strictly (i.e. `11.3.1`) or only a subset of them (i.e. `11.3` or `11`)."
         ].join("\n")
       end
 
@@ -62,7 +86,11 @@ module Fastlane
                                        env_name: "FL_ENSURE_XCODE_VERSION",
                                        description: "Xcode version to verify that is selected",
                                        is_string: true,
-                                       optional: true)
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :strict,
+                                       description: "Should the version be verified strictly (all 3 version numbers), or matching only the given version numbers (i.e. `11.3` == `11.3.x`)",
+                                       type: Boolean,
+                                       default_value: true)
         ]
       end
 

data/fastlane/lib/fastlane/actions/frame_screenshots.rb

@@ -45,6 +45,7 @@ module Fastlane
         [
           'frame_screenshots',
           'frameit # alias for "frame_screenshots"',
+          'frame_screenshots(use_platform: "ANDROID")',
           'frame_screenshots(silver: true)',
           'frame_screenshots(path: "/screenshots")',
           'frame_screenshots(rose_gold: true)'
@@ -56,7 +57,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include?(platform)
+        [:ios, :mac, :android].include?(platform)
       end
     end
   end

data/fastlane/lib/fastlane/actions/get_github_release.rb

@@ -129,6 +129,9 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :api_token,
                                        env_name: "FL_GITHUB_RELEASE_API_TOKEN",
                                        sensitive: true,
+                                       code_gen_sensitive: true,
+                                       default_value: ENV["GITHUB_API_TOKEN"],
+                                       default_value_dynamic: true,
                                        description: "GitHub Personal Token (required for private repositories)",
                                        optional: true)
         ]

data/fastlane/lib/fastlane/actions/gradle.rb

@@ -17,12 +17,16 @@ module Fastlane
     end
 
     class GradleAction < Action
+      # rubocop:disable Metrics/PerceivedComplexity
       def self.run(params)
         task = params[:task]
         flavor = params[:flavor]
         build_type = params[:build_type]
+        tasks = params[:tasks]
 
-        gradle_task = [task, flavor, build_type].join
+        gradle_task = gradle_task(task, flavor, build_type, tasks)
+
+        UI.user_error!('Please pass a gradle task or tasks') if gradle_task.empty?
 
         project_dir = params[:project_dir]
 
@@ -101,6 +105,28 @@ module Fastlane
 
         return result
       end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def self.gradle_task(task, flavor, build_type, tasks)
+        gradle_task = [task, flavor, build_type].join
+
+        if gradle_task.empty? && !tasks.nil?
+          gradle_task = tasks.join(' ')
+        end
+
+        gradle_task
+      end
+
+      def self.step_text(params)
+        task = params[:task]
+        flavor = params[:flavor]
+        build_type = params[:build_type]
+        tasks = params[:tasks]
+
+        gradle_task = gradle_task(task, flavor, build_type, tasks)
+
+        return gradle_task
+      end
 
       #####################################################
       # @!group Documentation
@@ -119,7 +145,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :task,
                                        env_name: 'FL_GRADLE_TASK',
                                        description: 'The gradle task you want to execute, e.g. `assemble`, `bundle` or `test`. For tasks such as `assembleMyFlavorRelease` you should use gradle(task: \'assemble\', flavor: \'Myflavor\', build_type: \'Release\')',
-                                       optional: false,
+                                       conflicting_options: [:tasks],
+                                       optional: true,
                                        is_string: true),
           FastlaneCore::ConfigItem.new(key: :flavor,
                                        env_name: 'FL_GRADLE_FLAVOR',
@@ -131,6 +158,13 @@ module Fastlane
                                        description: 'The build type that you want the task for, e.g. `Release`. Useful for some tasks such as `assemble`',
                                        optional: true,
                                        is_string: true),
+          FastlaneCore::ConfigItem.new(key: :tasks,
+                                       type: Array,
+                                       env_name: 'FL_GRADLE_TASKS',
+                                       description: 'The multiple gradle tasks that you want to execute, e.g. `[assembleDebug, bundleDebug]`',
+                                       conflicting_options: [:task],
+                                       optional: true,
+                                       is_string: false),
           FastlaneCore::ConfigItem.new(key: :flags,
                                        env_name: 'FL_GRADLE_FLAGS',
                                        description: 'All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`',
@@ -219,6 +253,13 @@ module Fastlane
           )
           ```
 
+          You can pass multiple gradle tasks:
+          ```ruby
+          gradle(
+            tasks: ["assembleDebug", "bundleDebug"]
+          )
+          ```
+
           You can pass properties to gradle:
           ```ruby
           gradle(

data/fastlane/lib/fastlane/actions/gym.rb

@@ -1,13 +1,9 @@
 module Fastlane
   module Actions
-    require 'fastlane/actions/build_ios_app'
-    class GymAction < BuildIosAppAction
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
+    require 'fastlane/actions/build_app'
+    class GymAction < BuildAppAction
       def self.description
-        "Alias for the `build_ios_app` action"
+        "Alias for the `build_app` action"
       end
     end
   end

data/fastlane/lib/fastlane/actions/import_from_git.rb

@@ -26,6 +26,10 @@ module Fastlane
                                        description: "The branch or tag to check-out on the repository",
                                        default_value: 'HEAD',
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :dependencies,
+                                      description: "The array of additional Fastfiles in the repository",
+                                      default_value: [],
+                                      optional: true),
           FastlaneCore::ConfigItem.new(key: :path,
                                        description: "The path of the Fastfile in the repository",
                                        default_value: 'fastlane/Fastfile',

data/fastlane/lib/fastlane/actions/last_git_tag.rb

@@ -2,7 +2,7 @@ module Fastlane
   module Actions
     class LastGitTagAction < Action
       def self.run(params)
-        Actions.last_git_tag_name
+        Actions.last_git_tag_name(true, params[:pattern])
       end
 
       #####################################################
@@ -14,7 +14,12 @@ module Fastlane
       end
 
       def self.available_options
-        []
+        [
+          FastlaneCore::ConfigItem.new(key: :pattern,
+                                       description: "Pattern to filter tags when looking for last one. Limit tags to ones matching given shell glob. If pattern lacks ?, *, or [, * at the end is implied",
+                                       default_value: nil,
+                                       optional: true)
+        ]
       end
 
       def self.output
@@ -26,7 +31,7 @@ module Fastlane
       end
 
       def self.authors
-        ["KrauseFx"]
+        ["KrauseFx", "wedkarz"]
       end
 
       def self.is_supported?(platform)
@@ -34,12 +39,16 @@ module Fastlane
       end
 
       def self.details
-        "If you are using this action on a **shallow clone**, *the default with some CI systems like Bamboo*, you need to ensure that you have also pulled all the git tags appropriately. Assuming your git repo has the correct remote set you can issue `sh('git fetch --tags')`."
+        [
+          "If you are using this action on a **shallow clone**, *the default with some CI systems like Bamboo*, you need to ensure that you have also pulled all the git tags appropriately. Assuming your git repo has the correct remote set you can issue `sh('git fetch --tags')`.",
+          "Pattern parameter allows you to filter to a subset of tags."
+        ].join("\n")
       end
 
       def self.example_code
         [
-          'last_git_tag'
+          'last_git_tag',
+          'last_git_tag(pattern: "release/v1.0/")'
         ]
       end
 

data/fastlane/lib/fastlane/actions/latest_testflight_build_number.rb

@@ -4,12 +4,17 @@ module Fastlane
   module Actions
     module SharedValues
       LATEST_TESTFLIGHT_BUILD_NUMBER = :LATEST_TESTFLIGHT_BUILD_NUMBER
+      LATEST_TESTFLIGHT_VERSION = :LATEST_TESTFLIGHT_VERSION
     end
 
     class LatestTestflightBuildNumberAction < Action
       def self.run(params)
-        build_number = AppStoreBuildNumberAction.run(params)
-        Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_BUILD_NUMBER] = build_number
+        AppStoreBuildNumberAction.run(params)
+        build_nr = Actions.lane_context[SharedValues::LATEST_BUILD_NUMBER]
+        build_v = Actions.lane_context[SharedValues::LATEST_VERSION]
+        Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_BUILD_NUMBER] = build_nr
+        Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_VERSION] = build_v
+        return build_nr
       end
 
       #####################################################
@@ -93,7 +98,8 @@ module Fastlane
 
       def self.output
         [
-          ['LATEST_TESTFLIGHT_BUILD_NUMBER', 'The latest build number of the latest version of the app uploaded to TestFlight']
+          ['LATEST_TESTFLIGHT_BUILD_NUMBER', 'The latest build number of the latest version of the app uploaded to TestFlight'],
+          ['LATEST_TESTFLIGHT_VERSION', 'The version of the latest build number']
         ]
       end
 

data/fastlane/lib/fastlane/actions/notarize.rb

@@ -0,0 +1,183 @@
+module Fastlane
+  module Actions
+    class NotarizeAction < Action
+      def self.run(params)
+        package_path = params[:package]
+        bundle_id = params[:bundle_id]
+        try_early_stapling = params[:try_early_stapling]
+        print_log = params[:print_log]
+        verbose = params[:verbose]
+
+        # Compress and read bundle identifier only for .app bundle.
+        compressed_package_path = nil
+        if File.extname(package_path) == '.app'
+          compressed_package_path = "#{package_path}.zip"
+          Actions.sh(
+            "ditto -c -k --rsrc --keepParent \"#{package_path}\" \"#{compressed_package_path}\"",
+            log: verbose
+          )
+
+          unless bundle_id
+            info_plist_path = File.join(package_path, 'Contents', 'Info.plist')
+            bundle_id = Actions.sh(
+              "/usr/libexec/PlistBuddy -c \"Print :CFBundleIdentifier\" \"#{info_plist_path}\"",
+              log: verbose
+            ).strip
+          end
+        end
+
+        UI.user_error!('Could not read bundle identifier, provide as a parameter') unless bundle_id
+
+        apple_id_account = CredentialsManager::AccountManager.new(user: params[:username])
+
+        # Add password as a temporary environment variable for altool.
+        # Use app specific password if specified.
+        ENV['FL_NOTARIZE_PASSWORD'] = ENV['FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD'] || apple_id_account.password
+
+        UI.message('Uploading package to notarization service, might take a while')
+
+        notarization_upload_command = "xcrun altool --notarize-app -t osx -f \"#{compressed_package_path || package_path}\" --primary-bundle-id #{bundle_id} -u #{apple_id_account.user} -p @env:FL_NOTARIZE_PASSWORD --output-format xml"
+        notarization_upload_command << " --asc-provider \"#{params[:asc_provider]}\"" if params[:asc_provider]
+
+        notarization_upload_response = Actions.sh(
+          notarization_upload_command,
+          log: verbose
+        )
+
+        FileUtils.rm_rf(compressed_package_path) if compressed_package_path
+
+        notarization_upload_plist = Plist.parse_xml(notarization_upload_response)
+        notarization_request_id = notarization_upload_plist['notarization-upload']['RequestUUID']
+
+        UI.success("Successfully uploaded package to notarization service with request identifier #{notarization_request_id}")
+
+        notarization_info = {}
+        while notarization_info.empty? || (notarization_info['Status'] == 'in progress')
+          if notarization_info.empty?
+            UI.message('Waiting to query request status')
+          elsif try_early_stapling
+            UI.message('Request in progress, trying early staple')
+
+            begin
+              self.staple(package_path, verbose)
+              UI.message('Successfully notarized and early stapled package.')
+
+              return
+            rescue
+              UI.message('Early staple failed, waiting to query again')
+            end
+          end
+
+          sleep(30)
+
+          UI.message('Querying request status')
+
+          notarization_info_response = Actions.sh(
+            "xcrun altool --notarization-info #{notarization_request_id} -u #{apple_id_account.user} -p @env:FL_NOTARIZE_PASSWORD --output-format xml",
+            log: verbose
+          )
+
+          notarization_info_plist = Plist.parse_xml(notarization_info_response)
+          notarization_info = notarization_info_plist['notarization-info']
+        end
+
+        log_url = notarization_info['LogFileURL']
+        ENV['FL_NOTARIZE_LOG_FILE_URL'] = log_url
+        log_suffix = ''
+        if log_url && print_log
+          log_response = Net::HTTP.get(URI(log_url))
+          log_json_object = JSON.parse(log_response)
+          log_suffix = ", with log:\n#{JSON.pretty_generate(log_json_object)}"
+        end
+
+        case notarization_info['Status']
+        when 'success'
+          UI.message('Stapling package')
+
+          self.staple(package_path, verbose)
+
+          UI.success("Successfully notarized and stapled package#{log_suffix}")
+        when 'invalid'
+          UI.user_error!("Could not notarize package with message '#{notarization_info['Status Message']}'#{log_suffix}")
+        else
+          UI.crash!("Could not notarize package with status '#{notarization_info['Status']}'#{log_suffix}")
+        end
+      ensure
+        ENV.delete('FL_NOTARIZE_PASSWORD')
+      end
+
+      def self.staple(package_path, verbose)
+        Actions.sh(
+          "xcrun stapler staple \"#{package_path}\"",
+          log: verbose
+        )
+      end
+
+      def self.description
+        'Notarizes a macOS app'
+      end
+
+      def self.authors
+        ['zeplin']
+      end
+
+      def self.available_options
+        username = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
+        username ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+        asc_provider = CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id)
+
+        [
+          FastlaneCore::ConfigItem.new(key: :package,
+                                       env_name: 'FL_NOTARIZE_PACKAGE',
+                                       description: 'Path to package to notarize, e.g. .app bundle or disk image',
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Could not find package at '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :try_early_stapling,
+                                       env_name: 'FL_NOTARIZE_TRY_EARLY_STAPLING',
+                                       description: 'Whether to try early stapling while the notarization request is in progress',
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :bundle_id,
+                                       env_name: 'FL_NOTARIZE_BUNDLE_ID',
+                                       description: 'Bundle identifier to uniquely identify the package',
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: 'FL_NOTARIZE_USERNAME',
+                                       description: 'Apple ID username',
+                                       default_value: username,
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :asc_provider,
+                                       env_name: 'FL_NOTARIZE_ASC_PROVIDER',
+                                       description: 'Provider short name for accounts associated with multiple providers',
+                                       optional: true,
+                                       default_value: asc_provider),
+          FastlaneCore::ConfigItem.new(key: :print_log,
+                                       env_name: 'FL_NOTARIZE_PRINT_LOG',
+                                       description: 'Whether to print notarization log file, listing issues on failure and warnings on success',
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       env_name: 'FL_NOTARIZE_VERBOSE',
+                                       description: 'Whether to log requests',
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :mac
+      end
+
+      def self.category
+        :code_signing
+      end
+    end
+  end
+end