fastlane 2.180.1 → 2.183.2

data/fastlane/lib/fastlane/actions/backup_xcarchive.rb

@@ -40,7 +40,7 @@ module Fastlane
                        end
 
             # Create zip
-            Actions.sh(%(cd "#{xcarchive_folder}" && zip -r -X "#{zip_file}" "#{xcarchive_file}" > /dev/null))
+            Actions.sh(%(cd "#{xcarchive_folder}" && zip -r -X -y "#{zip_file}" "#{xcarchive_file}" > /dev/null))
 
             # Moved to its final destination
             FileUtils.mv(zip_file, full_destination)

data/fastlane/lib/fastlane/actions/clipboard.rb

@@ -7,10 +7,7 @@ module Fastlane
         truncated_value = value[0..800].gsub(/\s\w+\s*$/, '...')
         UI.message("Storing '#{truncated_value}' in the clipboard 🎨")
 
-        if FastlaneCore::Helper.mac?
-          require 'open3'
-          Open3.popen3('pbcopy') { |input, _, _| input << value }
-        end
+        FastlaneCore::Clipboard.copy(content: value)
       end
 
       #####################################################
@@ -30,11 +27,11 @@ module Fastlane
       end
 
       def self.authors
-        ["KrauseFx", "joshdholtz"]
+        ["KrauseFx", "joshdholtz", "rogerluan"]
       end
 
       def self.is_supported?(platform)
-        true
+        FastlaneCore::Clipboard.is_supported?
       end
 
       def self.example_code

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

@@ -17,6 +17,7 @@ module Fastlane
         cmd << "--danger_id=#{danger_id}" if danger_id
         cmd << "--dangerfile=#{dangerfile}" if dangerfile
         cmd << "--fail-on-errors=true" if params[:fail_on_errors]
+        cmd << "--fail-if-no-pr=true" if params[:fail_if_no_pr]
         cmd << "--new-comment" if params[:new_comment]
         cmd << "--remove-previous-comments" if params[:remove_previous_comments]
         cmd << "--base=#{base}" if base
@@ -99,7 +100,12 @@ module Fastlane
                                        env_name: "FL_DANGER_PR",
                                        description: "Run danger on a specific pull request. e.g. \"https://github.com/danger/danger/pull/518\"",
                                        is_string: true,
-                                       optional: true)
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :fail_if_no_pr,
+                                       env_name: "FL_DANGER_FAIL_IF_NO_PR",
+                                       description: "Fail Danger execution if no PR is found",
+                                       type: Boolean,
+                                       default_value: false)
         ]
       end
 

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

@@ -332,7 +332,7 @@ To get more information about language and locale codes please read [Internation
 
 ## Use a clean status bar
 
-You can set `override_status_bar` to `true` to set the status bar to Tuesday January 9th at 9:41AM with full battery and reception.
+You can set `override_status_bar` to `true` to set the status bar to Tuesday January 9th at 9:41AM with full battery and reception. If you need more granular customization, to set a Carrier name for example, also set `override_status_bar_arguments` to the specific arguments to be passed to the `xcrun simctl status_bar override` command. Run `xcrun simctl status_bar --help` to see the options available.
 
 ## Editing the `Snapfile`
 

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

@@ -332,7 +332,24 @@ Use [_deliver_](https://docs.fastlane.tools/actions/deliver/) to upload iOS scre
 
 ## Use a clean status bar
 
-You can set `override_status_bar` to `true` in snapshot to set the status bar to Tuesday January 9th at 9:41AM with full battery and reception.
+You can set `override_status_bar` to `true` in snapshot to set the status bar to Tuesday January 9th at 9:41AM with full battery and reception. If you need more granular customization, to set a Carrier name for example, also set `override_status_bar_arguments` to the specific arguments to be passed to the `xcrun simctl status_bar override` command. Run `xcrun simctl status_bar --help` to see the options available.
+
+### Examples
+
+```ruby
+# Sets the time to 9:41AM with full battery and reception, with the default carrier name: Carrier
+capture_ios_screenshots(
+	override_status_bar: true
+)
+```
+
+```ruby
+# Set the time to 9:41AM, battery at 75% and charging, on the TELUS LTE network
+capture_ios_screenshots(
+	override_status_bar: true,
+	override_status_bar_arguments: "--time 9:41 --dataNetwork lte --cellularMode active --cellularBars 4 --batteryState charging --batteryLevel 75 --operatorName TELUS"
+)
+```
 
 ## Gray artifacts around text
 

data/fastlane/lib/fastlane/actions/ensure_env_vars.rb

@@ -3,15 +3,11 @@ module Fastlane
     class EnsureEnvVarsAction < Action
       def self.run(params)
         variables = params[:env_vars]
+        missing_variables = variables.select { |variable| ENV[variable].to_s.strip.empty? }
 
-        variables.each do |variable|
-          next unless ENV[variable].to_s.strip.empty?
-
-          UI.user_error!("Missing environment variable '#{variable}'")
-        end
+        UI.user_error!("Missing environment variable(s) '#{missing_variables.join('\', \'')}'") unless missing_variables.empty?
 
         is_one = variables.length == 1
-
         UI.success("Environment variable#{is_one ? '' : 's'} '#{variables.join('\', \'')}' #{is_one ? 'is' : 'are'} set!")
       end
 

data/fastlane/lib/fastlane/actions/get_managed_play_store_publishing_rights.rb

@@ -26,7 +26,9 @@ module Fastlane
         # Login
         credentials = JSON.parse(json_key_data)
         callback_uri = 'https://fastlane.github.io/managed_google_play-callback/callback.html'
-        uri = "https://play.google.com/apps/publish/delegatePrivateApp?service_account=#{credentials['client_email']}&continueUrl=#{URI.encode_www_form_component(callback_uri)}"
+        require 'addressable/uri'
+        continueUrl = Addressable::URI.encode(callback_uri)
+        uri = "https://play.google.com/apps/publish/delegatePrivateApp?service_account=#{credentials['client_email']}&continueUrl=#{continueUrl}"
 
         UI.message("To obtain publishing rights for custom apps on Managed Play Store, open the following URL and log in:")
         UI.message("")

data/fastlane/lib/fastlane/actions/git_branch.rb

@@ -2,7 +2,7 @@ module Fastlane
   module Actions
     class GitBranchAction < Action
       def self.run(params)
-        branch = Actions.git_branch
+        branch = Actions.git_branch || ""
         return "" if branch == "HEAD" # Backwards compatibility with the original (and documented) implementation
         branch
       end

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

@@ -42,11 +42,13 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :message,
                                        description: "The commit message that should be used"),
           FastlaneCore::ConfigItem.new(key: :skip_git_hooks,
-                                       description: "Set to true to pass --no-verify to git",
+                                       description: "Set to true to pass `--no-verify` to git",
+                                       default_value: false,
                                        type: Boolean,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :allow_nothing_to_commit,
                                        description: "Set to true to allow commit without any git changes in the files you want to commit",
+                                       default_value: false,
                                        type: Boolean,
                                        optional: true)
         ]

data/fastlane/lib/fastlane/actions/git_pull.rb

@@ -23,20 +23,14 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :only_tags,
                                        description: "Simply pull the tags, and not bring new commits to the current branch from the remote",
-                                       is_string: false,
+                                       type: Boolean,
                                        optional: true,
-                                       default_value: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("Please pass a valid value for only_tags. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
-                                       end),
+                                       default_value: false),
           FastlaneCore::ConfigItem.new(key: :rebase,
                                        description: "Rebase on top of the remote branch instead of merge",
-                                       is_string: false,
+                                       type: Boolean,
                                        optional: true,
-                                       default_value: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("Please pass a valid value for rebase. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
-                                       end)
+                                       default_value: false)
         ]
       end
 

data/fastlane/lib/fastlane/actions/git_submodule_update.rb

@@ -13,20 +13,19 @@ module Fastlane
       #####################################################
 
       def self.description
-        "Executes a git submodule command"
+        "Executes a git submodule update command"
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :recursive,
-           description: "Should the submodules be updated recursively",
-           type: Boolean,
-           default_value: false),
+                                       description: "Should the submodules be updated recursively?",
+                                       type: Boolean,
+                                       default_value: false),
           FastlaneCore::ConfigItem.new(key: :init,
-           description: "Should the submodules be initiated before update",
-           type: Boolean,
-           is_string: false,
-           default_value: false)
+                                       description: "Should the submodules be initiated before update?",
+                                       type: Boolean,
+                                       default_value: false)
         ]
       end
 
@@ -44,6 +43,15 @@ module Fastlane
         return true
       end
 
+      def self.example_code
+        [
+          'git_submodule_update',
+          'git_submodule_update(recursive: true)',
+          'git_submodule_update(init: true)',
+          'git_submodule_update(recursive: true, init: true)'
+        ]
+      end
+
       def self.category
         :source_control
       end

data/fastlane/lib/fastlane/actions/hipchat.rb

@@ -49,7 +49,8 @@ module Fastlane
           # Escape channel's name to guarantee it is a valid URL resource.
           # First of all we verify that the value is not already escaped,
           # escaping an escaped value will produce a wrong channel name.
-          escaped_channel = URI.unescape(channel) == channel ? URI.escape(channel) : channel
+          require 'addressable/uri'
+          escaped_channel = Addressable::URI.encode(channel) == channel ? Addressable::URI.encode(channel) : channel
           if user?(channel)
             params = { 'message' => message, 'message_format' => message_format }
             json_headers = { 'Content-Type' => 'application/json',

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

@@ -43,7 +43,7 @@ module Fastlane
                                        is_string: false,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :cache_path,
-                                       description: "The path to a directory where the repository should be cloned into. This is ignored if `version` is not specified. Defaults to `nil`, which causes the repository to be cloned on every call, to a temporary directory",
+                                       description: "The path to a directory where the repository should be cloned into. Defaults to `nil`, which causes the repository to be cloned on every call, to a temporary directory",
                                        default_value: nil,
                                        optional: true)
         ]
@@ -61,14 +61,14 @@ module Fastlane
         [
           'import_from_git(
             url: "git@github.com:fastlane/fastlane.git", # The URL of the repository to import the Fastfile from.
-            branch: "HEAD", # The branch to checkout on the repository
-            path: "fastlane/Fastfile", # The path of the Fastfile in the repository
+            branch: "HEAD", # The branch to checkout on the repository.
+            path: "fastlane/Fastfile", # The path of the Fastfile in the repository.
             version: "~> 1.0.0" # The version to checkout on the repository. Optimistic match operator can be used to select the latest version within constraints.
           )',
           'import_from_git(
             url: "git@github.com:fastlane/fastlane.git", # The URL of the repository to import the Fastfile from.
-            branch: "HEAD", # The branch to checkout on the repository
-            path: "fastlane/Fastfile", # The path of the Fastfile in the repository
+            branch: "HEAD", # The branch to checkout on the repository.
+            path: "fastlane/Fastfile", # The path of the Fastfile in the repository.
             version: [">= 1.1.0", "< 2.0.0"], # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
             cache_path: "~/.cache/fastlane/imported" # A directory in which the repository will be added, which means that it will not be cloned again on subsequent calls.
           )'

data/fastlane/lib/fastlane/actions/notification.rb

@@ -13,7 +13,7 @@ module Fastlane
           app_icon: :appIcon,
           content_image: :contentImage
         }
-        options = Hash[options.map { |k, v| [option_map.fetch(k, k), v] }]
+        options = options.transform_keys { |k| option_map.fetch(k, k) }
         TerminalNotifier.notify(message, options)
       end
 

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

@@ -1,70 +1,178 @@
+require 'fastlane/notification/slack'
+
 # rubocop:disable Style/CaseEquality
 # rubocop:disable Style/MultilineTernaryOperator
 # rubocop:disable Style/NestedTernaryOperator
 module Fastlane
   module Actions
     class SlackAction < Action
-      def self.is_supported?(platform)
-        true
-      end
+      class Runner
+        def initialize(slack_url)
+          @notifier = Fastlane::Notification::Slack.new(slack_url)
+        end
 
-      # As there is a text limit in the notifications, we are
-      # usually interested in the last part of the message
-      # e.g. for tests
-      def self.trim_message(message)
-        # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
-        start_index = [message.length - 7000, 0].max
-        message = message[start_index..-1]
-        # We want line breaks to be shown on slack output so we replace
-        # input non-interpreted line break with interpreted line break
-        message.gsub('\n', "\n")
-      end
+        def run(options)
+          options[:message] = self.class.trim_message(options[:message].to_s || '')
+          options[:message] = Fastlane::Notification::Slack::LinkConverter.convert(options[:message])
 
-      def self.run(options)
-        require 'slack-notifier'
+          options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
 
-        options[:message] = self.trim_message(options[:message].to_s || '')
-        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+          if options[:channel].to_s.length > 0
+            channel = options[:channel]
+            channel = ('#' + options[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+          end
 
-        options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
+          username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
 
-        if options[:channel].to_s.length > 0
-          channel = options[:channel]
-          channel = ('#' + options[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+          slack_attachment = self.class.generate_slack_attachments(options)
+          link_names = options[:link_names]
+          icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+
+          post_message(
+            channel: channel,
+            username: username,
+            attachments: [slack_attachment],
+            link_names: link_names,
+            icon_url: icon_url,
+            fail_on_error: options[:fail_on_error]
+          )
         end
 
-        username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
+        def post_message(channel:, username:, attachments:, link_names:, icon_url:, fail_on_error:)
+          @notifier.post_to_legacy_incoming_webhook(
+            channel: channel,
+            username: username,
+            link_names: link_names,
+            icon_url: icon_url,
+            attachments: attachments
+          )
+          UI.success('Successfully sent Slack notification')
+        rescue => error
+          UI.error("Exception: #{error}")
+          message = "Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile, this is usually caused by a misspelled or changed group/channel name or an expired SLACK_URL"
+          if fail_on_error
+            UI.user_error!(message)
+          else
+            UI.error(message)
+          end
+        end
 
-        notifier = Slack::Notifier.new(options[:slack_url], channel: channel, username: username)
+        # As there is a text limit in the notifications, we are
+        # usually interested in the last part of the message
+        # e.g. for tests
+        def self.trim_message(message)
+          # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
+          start_index = [message.length - 7000, 0].max
+          message = message[start_index..-1]
+          # We want line breaks to be shown on slack output so we replace
+          # input non-interpreted line break with interpreted line break
+          message.gsub('\n', "\n")
+        end
 
-        link_names = options[:link_names]
+        def self.generate_slack_attachments(options)
+          color = (options[:success] ? 'good' : 'danger')
+          should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
 
-        icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+          slack_attachment = {
+            fallback: options[:message],
+            text: options[:message],
+            pretext: options[:pretext],
+            color: color,
+            mrkdwn_in: ["pretext", "text", "fields", "message"],
+            fields: []
+          }
 
-        slack_attachment = generate_slack_attachments(options)
+          # custom user payloads
+          slack_attachment[:fields] += options[:payload].map do |k, v|
+            {
+              title: k.to_s,
+              value: Fastlane::Notification::Slack::LinkConverter.convert(v.to_s),
+              short: false
+            }
+          end
 
-        return [notifier, slack_attachment] if Helper.test? # tests will verify the slack attachments and other properties
+          # Add the lane to the Slack message
+          # This might be nil, if slack is called as "one-off" action
+          if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
+            slack_attachment[:fields] << {
+              title: 'Lane',
+              value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
+              short: true
+            }
+          end
 
-        begin
-          results = notifier.ping('', link_names: link_names, icon_url: icon_url, attachments: [slack_attachment])
-        rescue => exception
-          UI.error("Exception: #{exception}")
-        ensure
-          result = results.first if results
-          if !result.nil? && result.code.to_i == 200
-            UI.success('Successfully sent Slack notification')
-          else
-            UI.verbose(result) unless result.nil?
-            message = "Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile, this is usually caused by a misspelled or changed group/channel name or an expired SLACK_URL"
-            if options[:fail_on_error]
-              UI.user_error!(message)
+          # test_result
+          if should_add_payload[:test_result]
+            slack_attachment[:fields] << {
+              title: 'Result',
+              value: (options[:success] ? 'Success' : 'Error'),
+              short: true
+            }
+          end
+
+          # git branch
+          if Actions.git_branch && should_add_payload[:git_branch]
+            slack_attachment[:fields] << {
+              title: 'Git Branch',
+              value: Actions.git_branch,
+              short: true
+            }
+          end
+
+          # git_author
+          if Actions.git_author_email && should_add_payload[:git_author]
+            if FastlaneCore::Env.truthy?('FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS') && options[:success]
+            # We only show the git author if the build failed
             else
-              UI.error(message)
+              slack_attachment[:fields] << {
+                title: 'Git Author',
+                value: Actions.git_author_email,
+                short: true
+              }
             end
           end
+
+          # last_git_commit
+          if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
+            slack_attachment[:fields] << {
+              title: 'Git Commit',
+              value: Actions.last_git_commit_message,
+              short: false
+            }
+          end
+
+          # last_git_commit_hash
+          if Actions.last_git_commit_hash(true) && should_add_payload[:last_git_commit_hash]
+            slack_attachment[:fields] << {
+              title: 'Git Commit Hash',
+              value: Actions.last_git_commit_hash(short: true),
+              short: false
+            }
+          end
+
+          # merge additional properties
+          deep_merge(slack_attachment, options[:attachment_properties])
+        end
+
+        # Adapted from https://stackoverflow.com/a/30225093/158525
+        def self.deep_merge(a, b)
+          merger = proc do |key, v1, v2|
+            Hash === v1 && Hash === v2 ?
+              v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
+                                        v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
+          end
+          a.merge(b, &merger)
         end
       end
 
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.run(options)
+        Runner.new(options[:slack_url]).run(options)
+      end
+
       def self.description
         "Send a success/error message to your [Slack](https://slack.com) group"
       end
@@ -185,99 +293,13 @@ module Fastlane
       # @!group Helper
       #####################################################
 
-      def self.generate_slack_attachments(options)
-        color = (options[:success] ? 'good' : 'danger')
-        should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
-
-        slack_attachment = {
-          fallback: options[:message],
-          text: options[:message],
-          pretext: options[:pretext],
-          color: color,
-          mrkdwn_in: ["pretext", "text", "fields", "message"],
-          fields: []
-        }
-
-        # custom user payloads
-        slack_attachment[:fields] += options[:payload].map do |k, v|
-          {
-            title: k.to_s,
-            value: Slack::Notifier::Util::LinkFormatter.format(v.to_s),
-            short: false
-          }
-        end
-
-        # Add the lane to the Slack message
-        # This might be nil, if slack is called as "one-off" action
-        if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
-          slack_attachment[:fields] << {
-            title: 'Lane',
-            value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
-            short: true
-          }
-        end
-
-        # test_result
-        if should_add_payload[:test_result]
-          slack_attachment[:fields] << {
-            title: 'Result',
-            value: (options[:success] ? 'Success' : 'Error'),
-            short: true
-          }
-        end
-
-        # git branch
-        if Actions.git_branch && should_add_payload[:git_branch]
-          slack_attachment[:fields] << {
-            title: 'Git Branch',
-            value: Actions.git_branch,
-            short: true
-          }
-        end
-
-        # git_author
-        if Actions.git_author_email && should_add_payload[:git_author]
-          if FastlaneCore::Env.truthy?('FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS') && options[:success]
-            # We only show the git author if the build failed
-          else
-            slack_attachment[:fields] << {
-              title: 'Git Author',
-              value: Actions.git_author_email,
-              short: true
-            }
-          end
-        end
-
-        # last_git_commit
-        if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
-          slack_attachment[:fields] << {
-            title: 'Git Commit',
-            value: Actions.last_git_commit_message,
-            short: false
-          }
-        end
-
-        # last_git_commit_hash
-        if Actions.last_git_commit_hash(true) && should_add_payload[:last_git_commit_hash]
-          slack_attachment[:fields] << {
-            title: 'Git Commit Hash',
-            value: Actions.last_git_commit_hash(short: true),
-            short: false
-          }
-        end
-
-        # merge additional properties
-        deep_merge(slack_attachment, options[:attachment_properties])
+      def self.trim_message(message)
+        Runner.trim_message(message)
       end
 
-      # Adapted from https://stackoverflow.com/a/30225093/158525
-      def self.deep_merge(a, b)
-        merger = proc do |key, v1, v2|
-          Hash === v1 && Hash === v2 ?
-                 v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
-                   v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
-        end
-        a.merge(b, &merger)
+      def self.generate_slack_attachments(options)
+        UI.deprecated('`Fastlane::Actions::Slack.generate_slack_attachments` is subject to be removed as Slack recommends migrating `attachments` to Block Kit. fastlane will also follow the same direction.')
+        Runner.generate_slack_attachments(options)
       end
     end
   end