fastlane 2.168.0 → 2.173.0

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

@@ -237,7 +237,7 @@ The `keyword.strings` and `title.strings` are standard `.strings` file you alrea
 **Notes**
 
 - These `.strings` files **MUST** be utf-8 (UTF-8) or utf-16 encoded (UTF-16 BE with BOM). They also must begin with an empty line. If you are having trouble see [issue #1740](https://github.com/fastlane/fastlane/issues/1740)
-- You **MUST** provide a background if you want titles. _frameit_ will not add the tiles if a background is not specified.
+- You **MUST** provide a background if you want titles. _frameit_ will not add the titles if a background is not specified.
 
 ### Screenshot orientation
 

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

@@ -390,7 +390,7 @@ lane :beta do
 end
 ```
 
-By using the `force_for_new_devices` parameter, _match_ will check if the device count has changed since the last time you ran _match_, and automatically re-generate the provisioning profile if necessary. You can also use `force: true` to re-generate the provisioning profile on each run.
+By using the `force_for_new_devices` parameter, _match_ will check if the (enabled) device count has changed since the last time you ran _match_, and automatically re-generate the provisioning profile if necessary. You can also use `force: true` to re-generate the provisioning profile on each run.
 
 _**Important:** The `force_for_new_devices` parameter is ignored for App Store provisioning profiles since they don't contain any device information._
 

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

@@ -439,6 +439,10 @@ Use the `submission_information` parameter for additional submission specifiers,
 fastlane deliver submit_build --build_number 830 --submission_information "{\"export_compliance_uses_encryption\": false, \"add_id_info_uses_idfa\": false }"
 ```
 
+### App Privacy Details
+
+Starting on December 8, 2020, Apple announced that developers are required to provide app privacy details that will help users understand an app's privacy practies. _deliver_ does not allow for updating of this information but this can be done with the _upload_app_privacy_details_to_app_store_ action. More information on [Uploading App Privacy Details](https://docs.fastlane.tools/uploading-app-privacy-details)
+
 # Credentials
 
 A detailed description about how your credentials are handled is available in a [credentials_manager](https://github.com/fastlane/fastlane/tree/master/credentials_manager).

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

@@ -218,7 +218,7 @@ fastlane pilot upload --verbose
 
 ## Firewall Issues
 
-_pilot_ uses the iTunes Transporter to upload metadata and binaries. In case you are behind a firewall, you can specify a different transporter protocol from the command line using
+_pilot_ uses the iTunes [Transporter](https://help.apple.com/itc/transporteruserguide/#/apdATD1E1288-D1E1A1303-D1E1288A1126) to upload metadata and binaries. In case you are behind a firewall, you can specify a different transporter protocol from the command line using
 
 ```no-highlight
 DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS="-t DAV" pilot ...
@@ -231,6 +231,10 @@ ENV["DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS"] = "-t DAV"
 pilot...
 ```
 
+Note, however, that Apple recommends you don’t specify the `-t transport` and instead allow Transporter to use automatic transport discovery to determine the best transport mode for your packages. For this reason, if the `t` option is passed, we will raise a warning.
+
+Also note that `-t` is not the only additional parameter that can be used. The string specified in the `DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS` environment variable will be forwarded to Transporter. For all the available options, check [Apple's Transporter User Guide](https://help.apple.com/itc/transporteruserguide/#/apdATD1E1288-D1E1A1303-D1E1288A1126).
+
 ## Credentials Issues
 
 If your password contains special characters, _pilot_ may throw a confusing error saying your "Your Apple ID or password was entered incorrectly". The easiest way to fix this error is to change your password to something that **does not** contains special characters.

data/fastlane/lib/fastlane/actions/download_app_privacy_details_from_app_store.rb

@@ -0,0 +1,142 @@
+module Fastlane
+  module Actions
+    class DownloadAppPrivacyDetailsFromAppStoreAction < Action
+      DEFAULT_PATH = Fastlane::Helper.fastlane_enabled_folder_path
+      DEFAULT_FILE_NAME = "app_privacy_details.json"
+
+      def self.run(params)
+        require 'spaceship'
+
+        # Prompts select team if multiple teams and none specified
+        UI.message("Login to App Store Connect (#{params[:username]})")
+        Spaceship::ConnectAPI.login(params[:username], use_portal: false, use_tunes: true, tunes_team_id: params[:team_id], team_name: params[:team_name])
+        UI.message("Login successful")
+
+        # Get App
+        app = Spaceship::ConnectAPI::App.find(params[:app_identifier])
+        unless app
+          UI.user_error!("Could not find app with bundle identifier '#{params[:app_identifier]}' on account #{params[:username]}")
+        end
+
+        # Download usages and return a config
+        raw_usages = download_app_data_usages(params, app)
+
+        usages_config = []
+        if raw_usages.count == 1 && raw_usages.first.data_protection.id == Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_NOT_COLLECTED
+          usages_config << {
+            "data_protections" => [Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_NOT_COLLECTED]
+          }
+        else
+          grouped_usages = raw_usages.group_by do |usage|
+            usage.category.id
+          end
+          grouped_usages.sort_by(&:first).each do |key, usage_group|
+            purposes = usage_group.map(&:purpose).compact || []
+            data_protections = usage_group.map(&:data_protection).compact || []
+            usages_config << {
+              "category" => key,
+              "purposes" => purposes.map(&:id).sort.uniq,
+              "data_protections" => data_protections.map(&:id).sort.uniq
+            }
+          end
+        end
+
+        # Save to JSON file
+        json = JSON.pretty_generate(usages_config)
+        path = output_path(params)
+
+        UI.message("Writing file to #{path}")
+        File.write(path, json)
+      end
+
+      def self.output_path(params)
+        path = params[:output_json_path]
+        return File.absolute_path(path)
+      end
+
+      def self.download_app_data_usages(params, app)
+        UI.message("Downloading App Data Usage")
+
+        # Delete all existing usages for new ones
+        Spaceship::ConnectAPI::AppDataUsage.all(app_id: app.id, includes: "category,grouping,purpose,dataProtection", limit: 500)
+      end
+
+      def self.description
+        "Download App Privacy Details from an app in App Store Connect"
+      end
+
+      def self.available_options
+        user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
+        user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FASTLANE_USER",
+                                       description: "Your Apple ID Username for App Store Connect",
+                                       default_value: user,
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_APP_IDENTIFIER",
+                                       description: "The bundle identifier of your app",
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       env_name: "FASTLANE_ITC_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
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :team_name,
+                                       env_name: "FASTLANE_ITC_TEAM_NAME",
+                                       description: "The name of your App Store Connect team if you're in multiple teams",
+                                       optional: true,
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
+                                       default_value_dynamic: true),
+
+          # JSON paths
+          FastlaneCore::ConfigItem.new(key: :output_json_path,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_JSON_PATH",
+                                       description: "Path to the app usage data JSON file generated by interactive questions",
+                                       conflicting_options: [:skip_json_file_saving],
+                                       default_value: File.join(DEFAULT_PATH, DEFAULT_FILE_NAME))
+        ]
+      end
+
+      def self.author
+        "igor-makarov"
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac, :tvos].include?(platform)
+      end
+
+      def self.details
+        "Download App Privacy Details from an app in App Store Connect. For more detail information, view https://docs.fastlane.tools/uploading-app-privacy-details"
+      end
+
+      def self.example_code
+        [
+          'download_app_privacy_details_from_app_store(
+            username: "your@email.com",
+            team_name: "Your Team",
+            app_identifier: "com.your.bundle"
+          )',
+          'download_app_privacy_details_from_app_store(
+            username: "your@email.com",
+            team_name: "Your Team",
+            app_identifier: "com.your.bundle",
+            output_json_path: "fastlane/app_data_usages.json"
+          )'
+        ]
+      end
+
+      def self.category
+        :production
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/download_dsyms.rb

@@ -285,7 +285,6 @@ module Fastlane
                                        short_option: "-p",
                                        env_name: "DOWNLOAD_DSYMS_PLATFORM",
                                        description: "The app platform for dSYMs you wish to download (ios, appletvos)",
-                                       optional: true,
                                        default_value: :ios),
           FastlaneCore::ConfigItem.new(key: :version,
                                        short_option: "-v",

data/fastlane/lib/fastlane/actions/git_commit.rb

@@ -11,7 +11,11 @@ module Fastlane
         skip_git_hooks = params[:skip_git_hooks] ? '--no-verify' : ''
 
         if params[:allow_nothing_to_commit]
-          repo_clean = Actions.sh("git status --porcelain").empty?
+          # Here we check if the path passed in parameter contains any modification
+          # and we skip the `git commit` command if there is none.
+          # That means you can have other files modified that are not in the path parameter
+          # and still make use of allow_nothing_to_commit.
+          repo_clean = Actions.sh("git status #{paths} --porcelain").empty?
           UI.success("Nothing to commit, working tree clean ✅.") if repo_clean
           return if repo_clean
         end
@@ -42,7 +46,7 @@ module Fastlane
                                        type: Boolean,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :allow_nothing_to_commit,
-                                       description: "Set to true to allow commit without any git changes",
+                                       description: "Set to true to allow commit without any git changes in the files you want to commit",
                                        type: Boolean,
                                        optional: true)
         ]

data/fastlane/lib/fastlane/actions/github_api.rb

@@ -13,7 +13,7 @@ module Fastlane
 
           http_method = (params[:http_method] || 'GET').to_s.upcase
           url = construct_url(params[:server_url], params[:path], params[:url])
-          headers = construct_headers(params[:api_token], params[:headers])
+          headers = construct_headers(params[:api_token], params[:api_bearer], params[:headers])
           payload = construct_body(params[:body], params[:raw_body])
           error_handlers = params[:error_handlers] || {}
           secure = params[:secure]
@@ -89,12 +89,22 @@ module Fastlane
             FastlaneCore::ConfigItem.new(key: :api_token,
                                          env_name: "FL_GITHUB_API_TOKEN",
                                          description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
+                                         conflicting_options: [:api_bearer],
                                          sensitive: true,
                                          code_gen_sensitive: true,
                                          is_string: true,
                                          default_value: ENV["GITHUB_API_TOKEN"],
                                          default_value_dynamic: true,
-                                         optional: false),
+                                         optional: true),
+            FastlaneCore::ConfigItem.new(key: :api_bearer,
+                                         env_name: "FL_GITHUB_API_BEARER",
+                                         sensitive: true,
+                                         code_gen_sensitive: true,
+                                         is_string: true,
+                                         description: "Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable",
+                                         conflicting_options: [:api_token],
+                                         optional: true,
+                                         default_value: nil),
             FastlaneCore::ConfigItem.new(key: :http_method,
                                          env_name: "FL_GITHUB_API_HTTP_METHOD",
                                          description: "The HTTP method. e.g. GET / POST",
@@ -202,10 +212,11 @@ module Fastlane
 
         private
 
-        def construct_headers(api_token, overrides)
+        def construct_headers(api_token, api_bearer, overrides)
           require 'base64'
           headers = { 'User-Agent' => 'fastlane-github_api' }
           headers['Authorization'] = "Basic #{Base64.strict_encode64(api_token)}" if api_token
+          headers['Authorization'] = "Bearer #{api_bearer}" if api_bearer
           headers.merge(overrides || {})
         end
 

data/fastlane/lib/fastlane/actions/nexus_upload.rb

@@ -5,6 +5,7 @@ module Fastlane
         command = []
         command << "curl"
         command << verbose(params)
+        command << "--fail"
         command += ssl_options(params)
         command += proxy_options(params)
         command += upload_options(params)

data/fastlane/lib/fastlane/actions/onesignal.rb

@@ -17,6 +17,7 @@ module Fastlane
         apns_p12_password = params[:apns_p12_password]
         android_token = params[:android_token]
         android_gcm_sender_id = params[:android_gcm_sender_id]
+        organization_id = params[:organization_id]
 
         has_app_id = !app_id.empty?
         has_app_name = !app_name.empty?
@@ -43,6 +44,7 @@ module Fastlane
 
         payload["gcm_key"] = android_token unless android_token.nil?
         payload["android_gcm_sender_id"] = android_gcm_sender_id unless android_gcm_sender_id.nil?
+        payload["organization_id"] = organization_id unless organization_id.nil?
 
         # here's the actual lifting - POST or PUT to OneSignal
 
@@ -135,7 +137,13 @@ module Fastlane
                                        env_name: "APNS_ENV",
                                        description: "APNS environment",
                                        optional: true,
-                                       default_value: 'production')
+                                       default_value: 'production'),
+
+          FastlaneCore::ConfigItem.new(key: :organization_id,
+                                       env_name: "ONE_SIGNAL_ORGANIZATION_ID",
+                                       sensitive: true,
+                                       description: "OneSignal Organization ID",
+                                       optional: true)
         ]
       end
 
@@ -163,7 +171,8 @@ module Fastlane
             android_gcm_sender_id: "Your Android GCM Sender ID (optional)",
             apns_p12: "Path to Apple .p12 file (optional)",
             apns_p12_password: "Password for .p12 file (optional)",
-            apns_env: "production/sandbox (defaults to production)"
+            apns_env: "production/sandbox (defaults to production)",
+            organization_id: "Onesignal organization id (optional)"
           )',
           'onesignal(
             app_id: "Your OneSignal App ID",
@@ -173,7 +182,8 @@ module Fastlane
             android_gcm_sender_id: "Your Android GCM Sender ID (optional)",
             apns_p12: "Path to Apple .p12 file (optional)",
             apns_p12_password: "Password for .p12 file (optional)",
-            apns_env: "production/sandbox (defaults to production)"
+            apns_env: "production/sandbox (defaults to production)",
+            organization_id: "Onesignal organization id (optional)"
           )'
         ]
       end

data/fastlane/lib/fastlane/actions/pod_push.rb

@@ -43,6 +43,10 @@ module Fastlane
           command << "--skip-tests"
         end
 
+        if params[:use_json]
+          command << "--use-json"
+        end
+
         if params[:verbose]
           command << "--verbose"
         end
@@ -121,6 +125,11 @@ module Fastlane
                                        optional: true,
                                        type: Boolean,
                                        env_name: "FL_POD_PUSH_SKIP_TESTS"),
+          FastlaneCore::ConfigItem.new(key: :use_json,
+                                       description: "Convert the podspec to JSON before pushing it to the repo",
+                                       optional: true,
+                                       type: Boolean,
+                                       env_name: "FL_POD_PUSH_USE_JSON"),
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        description: "Show more debugging information",
                                        optional: true,

data/fastlane/lib/fastlane/actions/push_to_git_remote.rb

@@ -32,6 +32,9 @@ module Fastlane
         # optionally add the set-upstream component
         command << '--set-upstream' if params[:set_upstream]
 
+        # optionally add the --push_options components
+        params[:push_options].each { |push_option| command << "--push-option=#{push_option}" }
+
         # execute our command
         Actions.sh('pwd')
         return command.join(' ') if Helper.test?
@@ -84,7 +87,12 @@ module Fastlane
                                        env_name: "FL_GIT_PUSH_USE_SET_UPSTREAM",
                                        description: "Whether or not to use --set-upstream",
                                        type: Boolean,
-                                       default_value: false)
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :push_options,
+                                       env_name: "FL_GIT_PUSH_PUSH_OPTION",
+                                       description: "Array of strings to be passed using the '--push-option' option",
+                                       type: Array,
+                                       default_value: [])
         ]
       end
 

data/fastlane/lib/fastlane/actions/register_device.rb

@@ -27,7 +27,7 @@ module Fastlane
         end
 
         begin
-          Spaceship::ConnectAPI::Device.create(name: name, platform: platform, udid: udid)
+          Spaceship::ConnectAPI::Device.find_or_create(udid, name: name, platform: platform)
         rescue => ex
           UI.error(ex.to_s)
           UI.crash!("Failed to register new device (name: #{name}, platform: #{platform}, UDID: #{udid})")

data/fastlane/lib/fastlane/actions/register_devices.rb

@@ -77,7 +77,7 @@ module Fastlane
       end
 
       def self.try_create_device(name: nil, platform: nil, udid: nil)
-        Spaceship::ConnectAPI::Device.create(name: name, platform: platform, udid: udid)
+        Spaceship::ConnectAPI::Device.find_or_create(udid, name: name, platform: platform)
       rescue => ex
         UI.error(ex.to_s)
         UI.crash!("Failed to register new device (name: #{name}, UDID: #{udid})")
@@ -155,6 +155,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :username,
                                        env_name: "DELIVER_USER",
                                        description: "Optional: Your Apple ID",
+                                       optional: true,
                                        default_value: user,
                                        default_value_dynamic: true),
           FastlaneCore::ConfigItem.new(key: :platform,

data/fastlane/lib/fastlane/actions/set_github_release.rb

@@ -13,6 +13,7 @@ module Fastlane
 
         repo_name = params[:repository_name]
         api_token = params[:api_token]
+        api_bearer = params[:api_bearer]
         server_url = params[:server_url]
         tag_name = params[:tag_name]
 
@@ -28,6 +29,7 @@ module Fastlane
         GithubApiAction.run(
           server_url: server_url,
           api_token: api_token,
+          api_bearer: api_bearer,
           http_method: 'POST',
           path: "repos/#{repo_name}/releases",
           body: payload,
@@ -65,12 +67,13 @@ module Fastlane
           assets = params[:upload_assets]
           if assets && assets.count > 0
             # upload assets
-            self.upload_assets(assets, json['upload_url'], api_token)
+            self.upload_assets(assets, json['upload_url'], api_token, api_bearer)
 
             # fetch the release again, so that it contains the uploaded assets
             GithubApiAction.run(
               server_url: server_url,
               api_token: api_token,
+              api_bearer: api_bearer,
               http_method: 'GET',
               path: "repos/#{repo_name}/releases/#{release_id}",
               error_handlers: {
@@ -90,13 +93,13 @@ module Fastlane
         end
       end
 
-      def self.upload_assets(assets, upload_url_template, api_token)
+      def self.upload_assets(assets, upload_url_template, api_token, api_bearer)
         assets.each do |asset|
-          self.upload(asset, upload_url_template, api_token)
+          self.upload(asset, upload_url_template, api_token, api_bearer)
         end
       end
 
-      def self.upload(asset_path, upload_url_template, api_token)
+      def self.upload(asset_path, upload_url_template, api_token, api_bearer)
         # if it's a directory, zip it first in a temp directory, because we can only upload binary files
         absolute_path = File.absolute_path(asset_path)
 
@@ -107,14 +110,14 @@ module Fastlane
           Dir.mktmpdir do |dir|
             tmpzip = File.join(dir, File.basename(absolute_path) + '.zip')
             sh("cd \"#{File.dirname(absolute_path)}\"; zip -r --symlinks \"#{tmpzip}\" \"#{File.basename(absolute_path)}\" 2>&1 >/dev/null")
-            self.upload_file(tmpzip, upload_url_template, api_token)
+            self.upload_file(tmpzip, upload_url_template, api_token, api_bearer)
           end
         else
-          self.upload_file(absolute_path, upload_url_template, api_token)
+          self.upload_file(absolute_path, upload_url_template, api_token, api_bearer)
         end
       end
 
-      def self.upload_file(file, url_template, api_token)
+      def self.upload_file(file, url_template, api_token, api_bearer)
         require 'addressable/template'
         file_name = File.basename(file)
         expanded_url = Addressable::Template.new(url_template).expand(name: file_name).to_s
@@ -122,6 +125,7 @@ module Fastlane
         UI.important("Uploading #{file_name}")
         GithubApiAction.run(
           api_token: api_token,
+          api_bearer: api_bearer,
           http_method: 'POST',
           headers: headers,
           url: expanded_url,
@@ -173,12 +177,21 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :api_token,
                                        env_name: "FL_GITHUB_RELEASE_API_TOKEN",
                                        description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
+                                       conflicting_options: [:api_bearer],
                                        sensitive: true,
                                        code_gen_sensitive: true,
                                        is_string: true,
                                        default_value: ENV["GITHUB_API_TOKEN"],
                                        default_value_dynamic: true,
-                                       optional: false),
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :api_bearer,
+                                       env_name: "FL_GITHUB_RELEASE_API_BEARER",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       description: "Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable",
+                                       conflicting_options: [:api_token],
+                                       optional: true,
+                                       default_value: nil),
           FastlaneCore::ConfigItem.new(key: :tag_name,
                                        env_name: "FL_SET_GITHUB_RELEASE_TAG_NAME",
                                        description: "Pass in the tag name",