fastlane 2.175.0 → 2.180.0

data/fastlane/lib/fastlane/actions/app_store_build_number.rb

@@ -32,6 +32,10 @@ module Fastlane
           UI.message("Using App Store Connect API token...")
           Spaceship::ConnectAPI.token = token
         else
+          # Username is now optional since addition of App Store Connect API Key
+          # Force asking for username to prompt user if not already set
+          params.fetch(:username, force_ask: true)
+
           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")
@@ -100,7 +104,7 @@ module Fastlane
 
       def self.api_token(params)
         params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
-        api_token ||= Spaceship::ConnectAPI::Token.create(params[:api_key]) if params[:api_key]
+        api_token ||= Spaceship::ConnectAPI::Token.create(**params[:api_key]) if params[:api_key]
         api_token ||= Spaceship::ConnectAPI::Token.from_json_file(params[:api_key_path]) if params[:api_key_path]
         return api_token
       end
@@ -147,6 +151,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: :team_id,

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",
@@ -76,10 +76,13 @@ module Fastlane
                                        description: "The token session duration",
                                        optional: true,
                                        default_value: Spaceship::ConnectAPI::Token::MAX_TOKEN_DURATION,
-                                       type: Integer),
+                                       type: Integer,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("The duration can't be more than 1200 (20 minutes) and the value entered was '#{value}'") unless value <= 1200
+                                       end),
           FastlaneCore::ConfigItem.new(key: :in_house,
                                        env_name: "APP_STORE_CONNECT_API_KEY_IN_HOUSE",
-                                       description: "Is App Store or Enterprise (in house) team? App Store Connect API cannot not determine this on its own (yet)",
+                                       description: "Is App Store or Enterprise (in house) team? App Store Connect API cannot determine this on its own (yet)",
                                        optional: true,
                                        type: Boolean)
         ]
@@ -96,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/appaloosa.rb

@@ -10,7 +10,7 @@ module Fastlane
         binary_url = get_binary_link(binary, api_key, store_id, params[:group_ids])
         return if binary_url.nil?
         screenshots_url = get_screenshots_links(api_key, store_id, params[:screenshots], params[:locale], params[:device])
-        upload_on_appaloosa(api_key, store_id, binary_url, screenshots_url, params[:group_ids], params[:description])
+        upload_on_appaloosa(api_key, store_id, binary_url, screenshots_url, params[:group_ids], params[:description], params[:changelog])
       end
 
       def self.get_binary_link(binary, api_key, store_id, group_ids)
@@ -101,7 +101,7 @@ module Fastlane
         end.compact
       end
 
-      def self.upload_on_appaloosa(api_key, store_id, binary_path, screenshots, group_ids, description)
+      def self.upload_on_appaloosa(api_key, store_id, binary_path, screenshots, group_ids, description, changelog)
         screenshots = all_screenshots_links(screenshots)
         uri = URI("#{APPALOOSA_SERVER}/#{store_id}/mobile_application_updates/upload")
         http = Net::HTTP.new(uri.host, uri.port)
@@ -111,6 +111,7 @@ module Fastlane
                      api_key: api_key,
                      mobile_application_update: {
                        description: description,
+                       changelog: changelog,
                        binary_path: binary_path,
                        screenshot1: screenshots[0],
                        screenshot2: screenshots[1],
@@ -218,6 +219,10 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :description,
                                        env_name: 'FL_APPALOOSA_DESCRIPTION',
                                        description: 'Your app description',
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :changelog,
+                                       env_name: 'FL_APPALOOSA_CHANGELOG',
+                                       description: 'Your app changelog',
                                        optional: true)
         ]
       end

data/fastlane/lib/fastlane/actions/backup_file.rb

@@ -3,7 +3,7 @@ module Fastlane
     class BackupFileAction < Action
       def self.run(params)
         path = params[:path]
-        FileUtils.cp(path, "#{path}.back", { preserve: true })
+        FileUtils.cp(path, "#{path}.back", preserve: true)
         UI.message("Successfully created a backup 💾")
       end
 

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

@@ -33,6 +33,7 @@ module Fastlane
         GithubApiAction.run({
           server_url: params[:server_url],
           api_token: params[:api_token],
+          api_bearer: params[:api_bearer],
           secure: params[:secure],
           http_method: "PUT",
           path: File.join("repos", params[:repository_name], "contents", api_file_path),
@@ -104,12 +105,21 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :api_token,
                                        env_name: "FL_COMMIT_GITHUB_FILE_API_TOKEN",
                                        description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
+                                       conflicting_options: [:api_bearer],
                                        sensitive: true,
                                        is_string: true,
                                        code_gen_sensitive: true,
                                        default_value: ENV["GITHUB_API_TOKEN"],
                                        default_value_dynamic: true,
-                                       optional: false),
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :api_bearer,
+                                       env_name: "FL_COMMIT_GITHUB_FILE_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: :branch,
                                        env_name: "FL_COMMIT_GITHUB_FILE_BRANCH",
                                        description: "The branch that the file should be committed on (default: master)",

data/fastlane/lib/fastlane/actions/create_xcframework.rb

@@ -14,6 +14,11 @@ module Fastlane
         create_command << ['-output', "\"#{params[:output]}\""]
         create_command << ['-allow-internal-distribution'] if params[:allow_internal_distribution]
 
+        if File.directory?(params[:output])
+          UI.message("Deleting existing: #{params[:output]}")
+          FileUtils.remove_dir(params[:output])
+        end
+
         Actions.lane_context[SharedValues::XCFRAMEWORK_PATH] = params[:output]
 
         sh(create_command)

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

@@ -11,6 +11,7 @@ module Fastlane
         GithubApiAction.run(
           server_url: params[:server_url],
           api_token: params[:api_token],
+          api_bearer: params[:api_bearer],
           http_method: 'GET',
           path: "repos/#{params[:url]}/releases",
           error_handlers: {
@@ -133,7 +134,16 @@ module Fastlane
                                        default_value: ENV["GITHUB_API_TOKEN"],
                                        default_value_dynamic: true,
                                        description: "GitHub Personal Token (required for private repositories)",
-                                       optional: true)
+                                       conflicting_options: [:api_bearer],
+                                       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)
         ]
       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_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/github_api.rb

@@ -143,8 +143,9 @@ module Fastlane
                                          default_value: {},
                                          optional: true),
             FastlaneCore::ConfigItem.new(key: :headers,
+                                         env_name: "FL_GITHUB_API_HEADERS",
                                          description: "Optional headers to apply",
-                                         is_string: false,
+                                         type: Hash,
                                          default_value: {},
                                          optional: true),
             FastlaneCore::ConfigItem.new(key: :secure,

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(' ')
 
@@ -66,6 +67,12 @@ module Fastlane
                                        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),
+          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",
+                                       is_string: false,
+                                       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_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/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
 
@@ -24,6 +25,13 @@ module Fastlane
             description: 'Path to jazzy config file',
             is_string: true,
             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',
+            is_string: true,
+            optional: true
           )
         ]
       end
@@ -44,7 +52,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