fastlane 2.170.0 → 2.171.0

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

@@ -9,7 +9,10 @@ module Fastlane
         if options[:tag]
           tag = options[:tag]
         elsif options[:build_number]
-          tag = "#{options[:grouping]}/#{lane_name}/#{options[:prefix]}#{options[:build_number]}#{options[:postfix]}"
+          tag_components = [options[:grouping]]
+          tag_components << lane_name if options[:includes_lane]
+          tag_components << "#{options[:prefix]}#{options[:build_number]}#{options[:postfix]}"
+          tag = tag_components.join('/')
         else
           UI.user_error!("No value found for 'tag' or 'build_number'. At least one of them must be provided. Note that if you do specify a tag, all other arguments are ignored.")
         end
@@ -34,14 +37,14 @@ module Fastlane
       def self.details
         list = <<-LIST.markdown_list
           `grouping` is just to keep your tags organised under one 'folder', defaults to 'builds'
-          `lane` is the name of the current fastlane lane
+          `lane` is the name of the current fastlane lane, if chosen to be included via 'includes_lane' option, which defaults to 'true'
           `prefix` is anything you want to stick in front of the version number, e.g. 'v'
           `postfix` is anything you want to stick at the end of the version number, e.g. '-RC1'
           `build_number` is the build number, which defaults to the value emitted by the `increment_build_number` action
         LIST
 
         [
-          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number>`, where:".markdown_preserve_newlines,
+          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number><postfix>`, where:".markdown_preserve_newlines,
           list,
           "For example, for build 1234 in the 'appstore' lane, it will tag the commit with `builds/appstore/1234`."
         ].join("\n")
@@ -57,6 +60,11 @@ module Fastlane
                                        env_name: "FL_GIT_TAG_GROUPING",
                                        description: "Is used to keep your tags organised under one 'folder'",
                                        default_value: 'builds'),
+          FastlaneCore::ConfigItem.new(key: :includes_lane,
+                                       env_name: "FL_GIT_TAG_INCLUDES_LANE",
+                                       description: "Whether the current lane should be included in the tag and message composition, e.g. '<grouping>/<lane>/<prefix><build_number><postfix>'",
+                                       is_string: false,
+                                       default_value: true),
           FastlaneCore::ConfigItem.new(key: :prefix,
                                        env_name: "FL_GIT_TAG_PREFIX",
                                        description: "Anything you want to put in front of the version number (e.g. 'v')",
@@ -102,6 +110,7 @@ module Fastlane
           'add_git_tag # simple tag with default values',
           'add_git_tag(
             grouping: "fastlane-builds",
+            includes_lane: true,
             prefix: "v",
             postfix: "-RC1",
             build_number: 123

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/git_commit.rb

@@ -11,9 +11,9 @@ 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?
-          UI.success("Nothing to commit, working tree clean ✅.") if repo_clean
-          return if repo_clean
+          nothing_staged = Actions.sh("git --no-pager diff --name-only --staged").empty?
+          UI.success("Nothing staged to commit ✅.") if nothing_staged
+          return if nothing_staged
         end
 
         command = "git commit -m #{params[:message].shellescape} #{paths} #{skip_git_hooks}".strip

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/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/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",

data/fastlane/lib/fastlane/actions/slack.rb

@@ -115,8 +115,8 @@ module Fastlane
                                        is_string: false),
           FastlaneCore::ConfigItem.new(key: :default_payloads,
                                        env_name: "FL_SLACK_DEFAULT_PAYLOADS",
-                                       description: "Remove some of the default payloads. More information about the available payloads on GitHub",
-                                       optional: true,
+                                       description: "Specifies default payloads to include. Pass an empty array to suppress all the default payloads",
+                                       default_value: ['lane', 'test_result', 'git_branch', 'git_author', 'last_git_commit', 'last_git_commit_hash'],
                                        type: Array),
           FastlaneCore::ConfigItem.new(key: :attachment_properties,
                                        env_name: "FL_SLACK_ATTACHMENT_PROPERTIES",
@@ -159,8 +159,7 @@ module Fastlane
               "Build Date" => Time.new.to_s,
               "Built by" => "Jenkins",
             },
-            default_payloads: [:git_branch, :git_author], # Optional, lets you specify an allowlist of default payloads to include. Pass an empty array to suppress all the default payloads.
-                                                          # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit`, `last_git_commit_hash`.
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify default payloads to include. Pass an empty array to suppress all the default payloads.
             attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
                                      # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
               thumb_url: "http://example.com/path/to/thumb.png",
@@ -188,7 +187,7 @@ module Fastlane
 
       def self.generate_slack_attachments(options)
         color = (options[:success] ? 'good' : 'danger')
-        should_add_payload = ->(payload_name) { options[:default_payloads].nil? || options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
+        should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
 
         slack_attachment = {
           fallback: options[:message],