fastlane 2.173.0 → 2.194.0

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,8 +46,8 @@ 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",
-                                       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)",
+                                       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/#using-fastlane-api-key-hash-option)",
                                        type: Hash,
                                        optional: true,
                                        sensitive: 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

data/fastlane/lib/fastlane/actions/mailgun.rb

@@ -59,45 +59,39 @@ module Fastlane
                                        env_name: "MAILGUN_SUBJECT",
                                        description: "Subject of your mail",
                                        optional: true,
-                                       is_string: true,
                                        default_value: "fastlane build"),
           FastlaneCore::ConfigItem.new(key: :success,
-                                      env_name: "MAILGUN_SUCCESS",
-                                      description: "Was this build successful? (true/false)",
-                                      optional: true,
-                                      default_value: true,
-                                      is_string: false),
+                                       env_name: "MAILGUN_SUCCESS",
+                                       description: "Was this build successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :app_link,
-                                      env_name: "MAILGUN_APP_LINK",
-                                      description: "App Release link",
-                                      optional: false,
-                                      is_string: true),
+                                       env_name: "MAILGUN_APP_LINK",
+                                       description: "App Release link",
+                                       optional: false),
           FastlaneCore::ConfigItem.new(key: :ci_build_link,
-                                      env_name: "MAILGUN_CI_BUILD_LINK",
-                                      description: "CI Build Link",
-                                      optional: true,
-                                      is_string: true),
+                                       env_name: "MAILGUN_CI_BUILD_LINK",
+                                       description: "CI Build Link",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :template_path,
-                                      env_name: "MAILGUN_TEMPLATE_PATH",
-                                      description: "Mail HTML template",
-                                      optional: true,
-                                      is_string: true),
+                                       env_name: "MAILGUN_TEMPLATE_PATH",
+                                       description: "Mail HTML template",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :reply_to,
-                                      env_name: "MAILGUN_REPLY_TO",
-                                      description: "Mail Reply to",
-                                      optional: true,
-                                      is_string: true),
+                                       env_name: "MAILGUN_REPLY_TO",
+                                       description: "Mail Reply to",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :attachment,
-                                      env_name: "MAILGUN_ATTACHMENT",
-                                      description: "Mail Attachment filenames, either an array or just one string",
-                                      optional: true,
-                                      is_string: false),
+                                       env_name: "MAILGUN_ATTACHMENT",
+                                       description: "Mail Attachment filenames, either an array or just one string",
+                                       optional: true,
+                                       type: Array),
           FastlaneCore::ConfigItem.new(key: :custom_placeholders,
                                        short_option: "-p",
                                        env_name: "MAILGUN_CUSTOM_PLACEHOLDERS",
                                        description: "Placeholders for template given as a hash",
                                        default_value: {},
-                                       is_string: false,
                                        type: Hash)
         ]
       end

data/fastlane/lib/fastlane/actions/make_changelog_from_jenkins.rb

@@ -45,7 +45,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :include_commit_body,
                                        description: "Include the commit body along with the summary",
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true)
         ]
       end

data/fastlane/lib/fastlane/actions/match_nuke.rb

@@ -0,0 +1,59 @@
+module Fastlane
+  module Actions
+    class MatchNukeAction < Action
+      def self.run(params)
+        require 'match'
+
+        params.load_configuration_file("Matchfile")
+        params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
+
+        cert_type = Match.cert_type_sym(params[:type])
+        UI.important("Going to revoke your '#{cert_type}' certificate type and provisioning profiles")
+
+        Match::Nuke.new.run(params, type: cert_type)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Easily nuke your certificate and provisioning profiles (via _match_)"
+      end
+
+      def self.details
+        [
+          "Use the match_nuke action to revoke your certificates and provisioning profiles.",
+          "Don't worry, apps that are already available in the App Store / TestFlight will still work.",
+          "Builds distributed via Ad Hoc or Enterprise will be disabled after nuking your account, so you'll have to re-upload a new build.",
+          "After clearing your account you'll start from a clean state, and you can run match to generate your certificates and profiles again.",
+          "More information: https://docs.fastlane.tools/actions/match/"
+        ].join("\n")
+      end
+
+      def self.available_options
+        require 'match'
+        Match::Options.available_options
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'match_nuke(type: "development")', # See all other options https://github.com/fastlane/fastlane/blob/master/match/lib/match/module.rb#L23
+          'match_nuke(type: "development", api_key: app_store_connect_api_key)'
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.category
+        :code_signing
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/modify_services.rb

@@ -42,29 +42,65 @@ module Fastlane
 
       def self.services_mapping
         {
-            access_wifi: 'access_wifi',
-            app_group: 'app_group',
-            apple_pay: 'apple_pay',
-            associated_domains: 'associated_domains',
-            auto_fill_credential: 'auto_fill_credential',
-            data_protection: 'data_protection',
-            game_center: 'game_center',
-            health_kit: 'healthkit',
-            home_kit: 'homekit',
-            hotspot: 'hotspot',
-            icloud: 'icloud',
-            in_app_purchase: 'in_app_purchase',
-            inter_app_audio: 'inter_app_audio',
-            multipath: 'multipath',
-            network_extension: 'network_extension',
-            nfc_tag_reading: 'nfc_tag_reading',
-            personal_vpn: 'personal_vpn',
-            passbook: 'passbook',
-            push_notification: 'push_notification',
-            siri_kit: 'sirikit',
-            vpn_configuration: 'vpn_conf',
-            wallet: 'wallet',
-            wireless_accessory: 'wireless_conf'
+          access_wifi: 'access_wifi',
+          app_attest: 'app_attest',
+          app_group: 'app_group',
+          apple_pay: 'apple_pay',
+          associated_domains: 'associated_domains',
+          auto_fill_credential: 'auto_fill_credential',
+          class_kit: 'class_kit',
+          icloud: 'icloud',
+          custom_network_protocol: 'custom_network_protocol',
+          data_protection: 'data_protection',
+          extended_virtual_address_space: 'extended_virtual_address_space',
+          family_controls: 'family_controls',
+          file_provider_testing_mode: 'file_provider_testing_mode',
+          fonts: 'fonts',
+          game_center: 'game_center',
+          health_kit: 'health_kit',
+          hls_interstitial_preview: 'hls_interstitial_preview',
+          home_kit: 'home_kit',
+          hotspot: 'hotspot',
+          in_app_purchase: 'in_app_purchase',
+          inter_app_audio: 'inter_app_audio',
+          low_latency_hls: 'low_latency_hls',
+          managed_associated_domains: 'managed_associated_domains',
+          maps: 'maps',
+          multipath: 'multipath',
+          network_extension: 'network_extension',
+          nfc_tag_reading: 'nfc_tag_reading',
+          personal_vpn: 'personal_vpn',
+          passbook: 'passbook',
+          push_notification: 'push_notification',
+          sign_in_with_apple: 'sign_in_with_apple',
+          siri_kit: 'siri_kit',
+          system_extension: 'system_extension',
+          user_management: 'user_management',
+          vpn_configuration: 'vpn_configuration',
+          wallet: 'wallet',
+          wireless_accessory: 'wireless_accessory',
+          car_play_audio_app: 'car_play_audio_app',
+          car_play_messaging_app: 'car_play_messaging_app',
+          car_play_navigation_app: 'car_play_navigation_app',
+          car_play_voip_calling_app: 'car_play_voip_calling_app',
+          critical_alerts: 'critical_alerts',
+          hotspot_helper: 'hotspot_helper',
+          driver_kit: 'driver_kit',
+          driver_kit_endpoint_security: 'driver_kit_endpoint_security',
+          driver_kit_family_hid_device: 'driver_kit_family_hid_device',
+          driver_kit_family_networking: 'driver_kit_family_networking',
+          driver_kit_family_serial: 'driver_kit_family_serial',
+          driver_kit_hid_event_service: 'driver_kit_hid_event_service',
+          driver_kit_transport_hid: 'driver_kit_transport_hid',
+          multitasking_camera_access: 'multitasking_camera_access',
+          sf_universal_link_api: 'sf_universal_link_api',
+          vp9_decoder: 'vp9_decoder',
+          music_kit: 'music_kit',
+          shazam_kit: 'shazam_kit',
+          communication_notifications: 'communication_notifications',
+          group_activities: 'group_activities',
+          health_kit_estimate_recalibration: 'health_kit_estimate_recalibration',
+          time_sensitive_notifications: 'time_sensitive_notifications'
         }
       end
 
@@ -106,7 +142,6 @@ module Fastlane
                                        display_in_shell: false,
                                        env_name: "PRODUCE_ENABLE_SERVICES",
                                        description: "Array with Spaceship App Services (e.g. #{allowed_services_description})",
-                                       is_string: false,
                                        type: Hash,
                                        default_value: {},
                                        verify_block: proc do |value|

data/fastlane/lib/fastlane/actions/nexus_upload.rb

@@ -143,7 +143,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :ssl_verify,
                                        env_name: "FL_NEXUS_SSL_VERIFY",
                                        description: "Verify SSL",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :nexus_version,
@@ -161,7 +161,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        env_name: "FL_NEXUS_VERBOSE",
                                        description: "Make detailed output",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :proxy_username,