fastlane 2.178.0 → 2.182.0

data/fastlane/lib/fastlane/actions/app_store_connect_api_key.rb

@@ -29,7 +29,7 @@ module Fastlane
         key = {
           key_id: key_id,
           issuer_id: issuer_id,
-          key: key_content || File.binread(key_filepath),
+          key: key_content || File.binread(File.expand_path(key_filepath)),
           is_key_content_base64: is_key_content_base64,
           duration: duration,
           in_house: in_house
@@ -58,7 +58,7 @@ module Fastlane
                                        optional: true,
                                        conflicting_options: [:key_content],
                                        verify_block: proc do |value|
-                                         UI.user_error!("Couldn't find key p8 file at path '#{value}'") unless File.exist?(value)
+                                         UI.user_error!("Couldn't find key p8 file at path '#{value}'") unless File.exist?(File.expand_path(value))
                                        end),
           FastlaneCore::ConfigItem.new(key: :key_content,
                                        env_name: "APP_STORE_CONNECT_API_KEY_KEY",
@@ -99,7 +99,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        true
+        [:ios, :mac, :tvos].include?(platform)
       end
 
       def self.details

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

@@ -120,6 +120,10 @@ module Fastlane
         "The absolute path to the generated ipa file"
       end
 
+      def self.return_type
+        :string
+      end
+
       def self.author
         "KrauseFx"
       end

data/fastlane/lib/fastlane/actions/check_app_store_metadata.rb

@@ -28,6 +28,10 @@ module Fastlane
         return "true if precheck passes, else, false"
       end
 
+      def self.return_type
+        :bool
+      end
+
       def self.authors
         ["taquitos"]
       end

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/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/docs/upload_to_play_store.md

@@ -138,7 +138,7 @@ Inside of a given locale directory is a folder called `images`. Here you can sup
 - `promoGraphic`
 - `tvBanner`
 
-You can also supply screenshots by creating directories within the `images` directory with the following names, containing PNGs or JPEGs (image names are irrelevant):
+You can also supply screenshots by creating directories within the `images` directory with the following names, containing PNGs or JPEGs:
 
 - `phoneScreenshots/`
 - `sevenInchScreenshots/` (7-inch tablets)
@@ -146,6 +146,7 @@ You can also supply screenshots by creating directories within the `images` dire
 - `tvScreenshots/`
 - `wearScreenshots/`
 
+You may name images anything you like, but screenshots will appear in the Play Store in alphanumerical filename order.
 Note that these will replace the current images and screenshots on the play store listing, not add to them.
 
 ## Changelogs (What's new)

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_provisioning_profile.rb

@@ -68,6 +68,10 @@ module Fastlane
         "The UUID of the profile sigh just fetched/generated"
       end
 
+      def self.return_type
+        :string
+      end
+
       def self.details
         "**Note**: It is recommended to use [match](https://docs.fastlane.tools/actions/match/) according to the [codesigning.guide](https://codesigning.guide) for generating and maintaining your provisioning profiles. Use _sigh_ directly only if you want full control over what's going on and know more about codesigning."
       end

data/fastlane/lib/fastlane/actions/get_version_number.rb

@@ -8,14 +8,15 @@ module Fastlane
       require 'shellwords'
 
       def self.run(params)
-        folder = params[:xcodeproj] ? File.join(params[:xcodeproj], '..') : '.'
+        xcodeproj_path_or_dir = params[:xcodeproj] || '.'
+        xcodeproj_dir = File.extname(xcodeproj_path_or_dir) == ".xcodeproj" ? File.dirname(xcodeproj_path_or_dir) : xcodeproj_path_or_dir
         target_name = params[:target]
         configuration = params[:configuration]
 
         # Get version_number
-        project = get_project!(folder)
+        project = get_project!(xcodeproj_path_or_dir)
         target = get_target!(project, target_name)
-        plist_file = get_plist!(folder, target, configuration)
+        plist_file = get_plist!(xcodeproj_dir, target, configuration)
         version_number = get_version_number_from_plist!(plist_file)
 
         # Get from build settings (or project settings) if needed (ex: $(MARKETING_VERSION) is default in Xcode 11)
@@ -39,13 +40,18 @@ module Fastlane
         return version_number
       end
 
-      def self.get_project!(folder)
+      def self.get_project!(xcodeproj_path_or_dir)
         require 'xcodeproj'
-        project_path = Dir.glob("#{folder}/*.xcodeproj").first
-        if project_path
+        if File.extname(xcodeproj_path_or_dir) == ".xcodeproj"
+          project_path = xcodeproj_path_or_dir
+        else
+          project_path = Dir.glob("#{xcodeproj_path_or_dir}/*.xcodeproj").first
+        end
+
+        if project_path && File.exist?(project_path)
           return Xcodeproj::Project.open(project_path)
         else
-          UI.user_error!("Unable to find Xcode project in folder: #{folder}")
+          UI.user_error!("Unable to find Xcode project at #{project_path || xcodeproj_path_or_dir}")
         end
       end
 
@@ -147,11 +153,12 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
                              env_name: "FL_VERSION_NUMBER_PROJECT",
-                             description: "Path to the main Xcode project to read version number from, optional. By default will use the first Xcode project found within the project root directory",
+                             description: "Path to the Xcode project to read version number from, or its containing directory, optional. If ommitted, or if a directory is passed instead, it will use the first Xcode project found within the given directory, or the project root directory if none is passed",
                              optional: true,
                              verify_block: proc do |value|
-                               UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with?(".xcworkspace")
-                               UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) && !Helper.test?
+                               UI.user_error!("Please pass the path to the project or its containing directory, not the workspace path") if value.end_with?(".xcworkspace")
+                               UI.user_error!("Could not find file or directory at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                               UI.user_error!("Could not find Xcode project in directory at path '#{File.expand_path(value)}'") if File.extname(value) != ".xcodeproj" && Dir.glob("#{value}/*.xcodeproj").empty?
                              end),
           FastlaneCore::ConfigItem.new(key: :target,
                              env_name: "FL_VERSION_NUMBER_TARGET",

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

@@ -1,16 +1,10 @@
 module Fastlane
   module Actions
-    module SharedValues
-      GIT_BRANCH_ENV_VARS = %w(GIT_BRANCH BRANCH_NAME TRAVIS_BRANCH BITRISE_GIT_BRANCH CI_BUILD_REF_NAME CI_COMMIT_REF_NAME WERCKER_GIT_BRANCH BUILDKITE_BRANCH APPCENTER_BRANCH CIRCLE_BRANCH).reject do |branch|
-        # Removing because tests break on CircleCI
-        Helper.test? && branch == "CIRCLE_BRANCH"
-      end.freeze
-    end
-
     class GitBranchAction < Action
       def self.run(params)
-        env_name = SharedValues::GIT_BRANCH_ENV_VARS.find { |env_var| FastlaneCore::Env.truthy?(env_var) }
-        ENV.fetch(env_name.to_s) { `git symbolic-ref HEAD --short 2>/dev/null`.strip }
+        branch = Actions.git_branch || ""
+        return "" if branch == "HEAD" # Backwards compatibility with the original (and documented) implementation
+        branch
       end
 
       #####################################################
@@ -22,7 +16,7 @@ module Fastlane
       end
 
       def self.details
-        "If no branch could be found, this action will return an empty string"
+        "If no branch could be found, this action will return an empty string. This is a wrapper for the internal action Actions.git_branch"
       end
 
       def self.available_options

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_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/git_tag_exists.rb

@@ -45,6 +45,10 @@ module Fastlane
         "Boolean value whether the tag exists or not"
       end
 
+      def self.return_type
+        :bool
+      end
+
       def self.output
         [
         ]

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

@@ -48,6 +48,10 @@ module Fastlane
         "The absolute path to the installed provisioning profile"
       end
 
+      def self.return_type
+        :string
+      end
+
       def self.example_code
         [
           'install_provisioning_profile(path: "profiles/profile.mobileprovision")'

data/fastlane/lib/fastlane/actions/jira.rb

@@ -1,5 +1,9 @@
 module Fastlane
   module Actions
+    module SharedValues
+      JIRA_JSON = :JIRA_JSON
+    end
+
     class JiraAction < Action
       def self.run(params)
         Actions.verify_gem!('jira-ruby')
@@ -21,10 +25,28 @@ module Fastlane
                     password: password
                   }
 
-        client = JIRA::Client.new(options)
-        issue = client.Issue.find(ticket_id)
-        comment = issue.comments.build
-        comment.save({ 'body' => comment_text })
+        begin
+          client = JIRA::Client.new(options)
+          issue = client.Issue.find(ticket_id)
+          comment = issue.comments.build
+          comment.save({ 'body' => comment_text })
+
+          # An exact representation of the JSON returned from the JIRA API
+          # https://github.com/sumoheavy/jira-ruby/blob/master/lib/jira/base.rb#L67
+          json_response = comment.attrs
+          raise 'Failed to add a comment on Jira ticket' if json_response.nil?
+
+          Actions.lane_context[SharedValues::JIRA_JSON] = json_response
+          UI.success('Successfully added a comment on Jira ticket')
+          return json_response
+        rescue => exception
+          message = "Received exception when adding a Jira comment: #{exception}"
+          if params[:fail_on_error]
+            UI.user_error!(message)
+          else
+            UI.error(message)
+          end
+        end
       end
 
       #####################################################
@@ -32,7 +54,7 @@ module Fastlane
       #####################################################
 
       def self.description
-        "Leave a comment on JIRA tickets"
+        "Leave a comment on a Jira ticket"
       end
 
       def self.available_options
@@ -50,13 +72,13 @@ module Fastlane
                                       default_value: ""),
           FastlaneCore::ConfigItem.new(key: :username,
                                        env_name: "FL_JIRA_USERNAME",
-                                       description: "Username for JIRA instance",
+                                       description: "Username for Jira instance",
                                        verify_block: proc do |value|
                                          UI.user_error!("No username") if value.to_s.length == 0
                                        end),
           FastlaneCore::ConfigItem.new(key: :password,
                                        env_name: "FL_JIRA_PASSWORD",
-                                       description: "Password for Jira",
+                                       description: "Password or API token for Jira",
                                        sensitive: true,
                                        verify_block: proc do |value|
                                          UI.user_error!("No password") if value.to_s.length == 0
@@ -72,15 +94,35 @@ module Fastlane
                                        description: "Text to add to the ticket as a comment",
                                        verify_block: proc do |value|
                                          UI.user_error!("No comment specified") if value.to_s.length == 0
-                                       end)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :fail_on_error,
+                                       env_name: "FL_JIRA_FAIL_ON_ERROR",
+                                       description: "Should an error adding the Jira comment cause a failure?",
+                                       type: Boolean,
+                                       optional: true,
+                                       default_value: true) # Default value is true for 'Backward compatibility'
+        ]
+      end
+
+      def self.output
+        [
+          ['JIRA_JSON', 'The whole Jira API JSON object']
         ]
       end
 
       def self.return_value
+        [
+          "A hash containing all relevant information of the Jira comment",
+          "Access Jira comment 'id', 'author', 'body', and more"
+        ].join("\n")
+      end
+
+      def self.return_type
+        :hash
       end
 
       def self.authors
-        ["iAmChrisTruman"]
+        ["iAmChrisTruman", "crazymanish"]
       end
 
       def self.is_supported?(platform)
@@ -92,17 +134,22 @@ module Fastlane
           'jira(
             url: "https://bugs.yourdomain.com",
             username: "Your username",
-            password: "Your password",
-            ticket_id: "Ticket ID, i.e. IOS-123",
+            password: "Your password or API token",
+            ticket_id: "IOS-123",
             comment_text: "Text to post as a comment"
-          )',
+          )', # How to get API token: https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/#get-an-api-token
           'jira(
             url: "https://yourserverdomain.com",
             context_path: "/jira",
             username: "Your username",
-            password: "Your password",
-            ticket_id: "Ticket ID, i.e. IOS-123",
+            password: "Your password or API token",
+            ticket_id: "IOS-123",
             comment_text: "Text to post as a comment"
+          )',
+          'jira(
+            ticket_id: "IOS-123",
+            comment_text: "Text to post as a comment",
+            fail_on_error: false
           )'
         ]
       end