fastlane_hotfix 2.165.0 → 2.187.0

data/fastlane/lib/fastlane/actions/ifttt.rb

@@ -53,18 +53,15 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :value1,
                                        env_name: "IFTTT_VALUE1",
                                        description: "Extra data sent with the event",
-                                       optional: true,
-                                       is_string: true),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :value2,
                                       env_name: "IFTTT_VALUE2",
                                       description: "Extra data sent with the event",
-                                      optional: true,
-                                      is_string: true),
+                                      optional: true),
           FastlaneCore::ConfigItem.new(key: :value3,
                                        env_name: "IFTTT_VALUE3",
                                        description: "Extra data sent with the event",
-                                       optional: true,
-                                       is_string: true)
+                                       optional: true)
         ]
       end
 

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

@@ -24,7 +24,7 @@ module Fastlane
           # `conflicting_options`, `verify_block`) are completely ignored.
           FastlaneCore::ConfigItem.new(key: :url,
                                        description: "The URL of the repository to import the Fastfile from",
-                                       default_value: nil),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :branch,
                                        description: "The branch or tag to check-out on the repository",
                                        default_value: 'HEAD',
@@ -39,12 +39,10 @@ module Fastlane
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :version,
                                        description: "The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints",
-                                       default_value: nil,
-                                       is_string: false,
+                                       type: Array,
                                        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",
-                                       default_value: nil,
+                                       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",
                                        optional: true)
         ]
       end
@@ -61,14 +59,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/increment_build_number.rb

@@ -33,10 +33,11 @@ module Fastlane
         agv_disabled = !system([command_prefix, 'agvtool what-version', command_suffix].join(' '))
         raise "Apple Generic Versioning is not enabled." if agv_disabled && params[:build_number].nil?
 
+        mode = params[:skip_info_plist] ? '' : ' -all'
         command = [
           command_prefix,
           'agvtool',
-          params[:build_number] ? "new-version -all #{params[:build_number].to_s.strip}" : 'next-version -all',
+          params[:build_number] ? "new-version#{mode} #{params[:build_number].to_s.strip}" : "next-version#{mode}",
           command_suffix
         ].join(' ')
 
@@ -65,7 +66,12 @@ module Fastlane
                                        env_name: "FL_BUILD_NUMBER_BUILD_NUMBER",
                                        description: "Change to a specific version. When you provide this parameter, Apple Generic Versioning does not have to be enabled",
                                        optional: true,
-                                       is_string: false),
+                                       skip_type_validation: true), # allow Integer, String
+          FastlaneCore::ConfigItem.new(key: :skip_info_plist,
+                                       env_name: "FL_BUILD_NUMBER_SKIP_INFO_PLIST",
+                                       description: "Don't update Info.plist files when updating the build version",
+                                       type: Boolean,
+                                       default_value: false),
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
                                        env_name: "FL_BUILD_NUMBER_PROJECT",
                                        description: "optional, you must specify the path to your main Xcode project if it is not in the project root directory",

data/fastlane/lib/fastlane/actions/install_on_device.rb

@@ -35,26 +35,23 @@ module Fastlane
                                        short_option: "-X",
                                        env_name: "FL_IOD_EXTRA",
                                        description: "Extra Commandline arguments passed to ios-deploy",
-                                       optional: true,
-                                       is_string: true),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :device_id,
                                        short_option: "-d",
                                        env_name: "FL_IOD_DEVICE_ID",
                                        description: "id of the device / if not set defaults to first found device",
-                                       optional: true,
-                                       is_string: true),
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :skip_wifi,
                                        short_option: "-w",
                                        env_name: "FL_IOD_WIFI",
                                        description: "Do not search for devices via WiFi",
                                        optional: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :ipa,
                                        short_option: "-i",
                                        env_name: "FL_IOD_IPA",
                                        description: "The IPA file to put on the device",
                                        optional: true,
-                                       is_string: true,
                                        default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] || Dir["*.ipa"].first,
                                        default_value_dynamic: true,
                                        verify_block: proc do |value|

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

@@ -66,35 +66,32 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :api_token,
-                                     env_name: "INSTALLR_API_TOKEN",
-                                     sensitive: true,
-                                     description: "API Token for Installr Access",
-                                     verify_block: proc do |value|
-                                       UI.user_error!("No API token for Installr given, pass using `api_token: 'token'`") unless value && !value.empty?
-                                     end),
+                                       env_name: "INSTALLR_API_TOKEN",
+                                       sensitive: true,
+                                       description: "API Token for Installr Access",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API token for Installr given, pass using `api_token: 'token'`") unless value && !value.empty?
+                                       end),
           FastlaneCore::ConfigItem.new(key: :ipa,
-                                     env_name: "INSTALLR_IPA_PATH",
-                                     description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
-                                     default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
-                                     default_value_dynamic: true,
-                                     verify_block: proc do |value|
-                                       UI.user_error!("Couldn't find build file at path '#{value}'") unless File.exist?(value)
-                                     end),
+                                       env_name: "INSTALLR_IPA_PATH",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
+                                       default_value_dynamic: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find build file at path '#{value}'") unless File.exist?(value)
+                                       end),
           FastlaneCore::ConfigItem.new(key: :notes,
-                                     env_name: "INSTALLR_NOTES",
-                                     description: "Release notes",
-                                     is_string: true,
-                                     optional: true),
+                                       env_name: "INSTALLR_NOTES",
+                                       description: "Release notes",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :notify,
-                                     env_name: "INSTALLR_NOTIFY",
-                                     description: "Groups to notify (e.g. 'dev,qa')",
-                                     is_string: true,
-                                     optional: true),
+                                       env_name: "INSTALLR_NOTIFY",
+                                       description: "Groups to notify (e.g. 'dev,qa')",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :add,
-                                     env_name: "INSTALLR_ADD",
-                                     description: "Groups to add (e.g. 'exec,ops')",
-                                     is_string: true,
-                                     optional: true)
+                                       env_name: "INSTALLR_ADD",
+                                       description: "Groups to add (e.g. 'exec,ops')",
+                                       optional: true)
         ]
       end
 

data/fastlane/lib/fastlane/actions/ipa.rb

@@ -159,12 +159,12 @@ module Fastlane
                                        env_name: "IPA_CLEAN",
                                        description: "Clean project before building",
                                        optional: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :archive,
                                        env_name: "IPA_ARCHIVE",
                                        description: "Archive project after building",
                                        optional: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :destination,
                                        env_name: "IPA_DESTINATION",
                                        description: "Build destination. Defaults to current directory",

data/fastlane/lib/fastlane/actions/jazzy.rb

@@ -5,6 +5,7 @@ module Fastlane
         Actions.verify_gem!('jazzy')
         command = "jazzy"
         command << " --config #{params[:config]}" if params[:config]
+        command << " --module-version #{params[:module_version]}" if params[:module_version]
         Actions.sh(command)
       end
 
@@ -18,13 +19,14 @@ module Fastlane
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(
-            key: :config,
-            env_name: 'FL_JAZZY_CONFIG',
-            description: 'Path to jazzy config file',
-            is_string: true,
-            optional: true
-          )
+          FastlaneCore::ConfigItem.new(key: :config,
+                                       env_name: 'FL_JAZZY_CONFIG',
+                                       description: 'Path to jazzy config file',
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :module_version,
+                                       env_name: 'FL_JAZZY_MODULE_VERSION',
+                                       description: 'Version string to use as part of the the default docs title and inside the docset',
+                                       optional: true)
         ]
       end
 
@@ -44,7 +46,8 @@ module Fastlane
 
       def self.example_code
         [
-          'jazzy'
+          'jazzy',
+          'jazzy(config: ".jazzy.yaml", module_version: "2.1.37")'
         ]
       end
 

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

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

@@ -38,7 +38,7 @@ module Fastlane
 
         [
           FastlaneCore::ConfigItem.new(key: :api_key_path,
-                                       env_name: "APPSTORE_BUILD_NUMBER_API_KEY_PATH",
+                                       env_names: ["APPSTORE_BUILD_NUMBER_API_KEY_PATH", "APP_STORE_CONNECT_API_KEY_PATH"],
                                        description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
                                        optional: true,
                                        conflicting_options: [:api_key],
@@ -46,7 +46,7 @@ module Fastlane
                                          UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
                                        end),
           FastlaneCore::ConfigItem.new(key: :api_key,
-                                       env_name: "APPSTORE_BUILD_NUMBER_API_KEY",
+                                       env_names: ["APPSTORE_BUILD_NUMBER_API_KEY", "APP_STORE_CONNECT_API_KEY"],
                                        description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
                                        type: Hash,
                                        optional: true,
@@ -57,7 +57,7 @@ module Fastlane
                                        env_name: "CURRENT_BUILD_NUMBER_LIVE",
                                        description: "Query the live version (ready-for-sale)",
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :app_identifier,
                                        short_option: "-a",
@@ -70,6 +70,7 @@ module Fastlane
                                        short_option: "-u",
                                        env_name: "ITUNESCONNECT_USER",
                                        description: "Your Apple ID Username",
+                                       optional: true,
                                        default_value: user,
                                        default_value_dynamic: true),
           FastlaneCore::ConfigItem.new(key: :version,
@@ -81,7 +82,6 @@ module Fastlane
                                        env_name: "APPSTORE_PLATFORM",
                                        description: "The platform to use (optional)",
                                        optional: true,
-                                       is_string: true,
                                        default_value: "ios",
                                        verify_block: proc do |value|
                                          UI.user_error!("The platform can only be ios, osx, or appletvos") unless %('osx', ios', 'appletvos').include?(value)
@@ -90,13 +90,13 @@ module Fastlane
                                        env_name: "INITIAL_BUILD_NUMBER",
                                        description: "sets the build number to given value if no build is in current train",
                                        default_value: 1,
-                                       is_string: false),
+                                       skip_type_validation: true), # allow Integer, String
           FastlaneCore::ConfigItem.new(key: :team_id,
                                        short_option: "-k",
                                        env_name: "LATEST_TESTFLIGHT_BUILD_NUMBER_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
+                                       skip_type_validation: true, # allow Integer, String
                                        code_gen_sensitive: true,
                                        default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                        default_value_dynamic: true),

data/fastlane/lib/fastlane/actions/lcov.rb

@@ -22,21 +22,17 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :project_name,
                                        env_name: "FL_LCOV_PROJECT_NAME",
                                        description: "Name of the project"),
-
           FastlaneCore::ConfigItem.new(key: :scheme,
                                        env_name: "FL_LCOV_SCHEME",
                                        description: "Scheme of the project"),
-
           FastlaneCore::ConfigItem.new(key: :arch,
                                        env_name: "FL_LCOV_ARCH",
                                        description: "The build arch where will search .gcda files",
                                        default_value: "i386"),
-
           FastlaneCore::ConfigItem.new(key: :output_dir,
                                        env_name: "FL_LCOV_OUTPUT_DIR",
                                        description: "The output directory that coverage data will be stored. If not passed will use coverage_reports as default value",
                                        optional: true,
-                                       is_string: true,
                                        default_value: "coverage_reports")
         ]
       end