fastlane 0.11.0 → 0.12.0

data/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -6,7 +6,7 @@ module Fastlane
 
     # Raises an exception and stop the lane execution if the repo is not in a clean state
     class EnsureGitStatusCleanAction < Action
-      def self.run(_params)
+      def self.run(params)
         repo_clean = `git status --porcelain`.empty?
 
         if repo_clean

data/lib/fastlane/actions/frameit.rb

@@ -7,9 +7,9 @@ module Fastlane
         require 'frameit'
 
         begin
-          FastlaneCore::UpdateChecker.start_looking_for_update('frameit')
+          FastlaneCore::UpdateChecker.start_looking_for_update('frameit') unless Helper.is_test?
           color = Frameit::Editor::Color::BLACK
-          color = Frameit::Editor::Color::SILVER if [:silver, :white].include?(params.first)
+          color = Frameit::Editor::Color::SILVER if [:silver, :white].include?(params)
 
           screenshots_folder = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
           screenshots_folder ||= FastlaneFolder.path

data/lib/fastlane/actions/gcovr.rb

@@ -60,8 +60,8 @@ module Fastlane
         gcovr_args = nil
 
         # Allows for a whole variety of configurations
-        if params.first.is_a? Hash
-          params_hash = params.first
+        if params.is_a? Hash
+          params_hash = params
 
           # Check if an output path was given
           if params_hash.has_key? :output

data/lib/fastlane/actions/hipchat.rb

@@ -4,26 +4,12 @@ module Fastlane
     end
 
     class HipchatAction < Action
-      def self.run(params)
-        options = { message: '',
-                    success: true,
-                    channel: nil
-                  }.merge(params.first || {})
-
+      def self.run(options)
         require 'net/http'
         require 'uri'
 
-        api_token = ENV['HIPCHAT_API_TOKEN']
-        api_version = ENV['HIPCHAT_API_VERSION']
-
-        unless api_token
-          Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_TOKEN\"] = \"your token\"' to your Fastfile's `before_all` section.".red
-          raise 'No HIPCHAT_API_TOKEN given.'.red
-        end
-        if api_version.nil? || ![1, 2].include?(api_version[0].to_i)
-          Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_VERSION\"] = \"1 or 2\"' to your Fastfile's `before_all` section.".red
-          raise 'No HIPCHAT_API_VERSION given.'.red
-        end
+        api_token = options[:api_token]
+        api_version = options[:version]
 
         channel = options[:channel]
         color = (options[:success] ? 'green' : 'red')
@@ -94,12 +80,39 @@ module Fastlane
 
       def self.available_options
         [
-          ['', 'Hipchat API Token', 'HIPCHAT_API_TOKEN'],
-          ['', 'Version of the Hipchat API. Must be 1 or 2', 'HIPCHAT_API_VERSION'],
-          ['message', 'The message to post on HipChat'],
-          ['channel', 'The room or @username'],
-          ['success', 'Is this a success message?'],
-        ]
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_HIPCHAT_MESSAGE",
+                                       description: "The message to post on HipChat",
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       env_name: "FL_HIPCHAT_CHANNEL",
+                                       description: "The room or @username",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "HIPCHAT_API_TOKEN",
+                                       description: "Hipchat API Token",
+                                       verify_block: Proc.new do |value|
+                                        unless value.to_s.length > 0
+                                          Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_TOKEN\"] = \"your token\"' to your Fastfile's `before_all` section.".red
+                                          raise 'No HIPCHAT_API_TOKEN given.'.red
+                                        end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :success,
+                                       env_name: "FL_HIPCHAT_SUCCESS",
+                                       description: "Was this build successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       env_name: "HIPCHAT_API_VERSION",
+                                       description: "Version of the Hipchat API. Must be 1 or 2",
+                                       verify_block: Proc.new do |value|
+                                        if api_version.nil? || ![1, 2].include?(api_version[0].to_i)
+                                          Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_VERSION\"] = \"1 or 2\"' to your Fastfile's `before_all` section.".red
+                                          raise 'No HIPCHAT_API_VERSION given.'.red
+                                        end
+                                       end)
+          ]
       end
 
       def self.author

data/lib/fastlane/actions/hockey.rb

@@ -10,37 +10,25 @@ module Fastlane
     end
 
     class HockeyAction < Action
-      def self.run(params)
+      def self.run(options)
         # Available options: http://support.hockeyapp.net/kb/api/api-versions#upload-version
-        options = {
-          notes: 'No changelog given',
-          status: 2,
-          notify: 1
-        }.merge(params.first)
-
-        options[:ipa] ||= Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-        options[:dsym] ||= Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]
 
         require 'shenzhen'
         require 'shenzhen/plugins/hockeyapp'
 
-        raise "No API Token for Hockey given, pass using `api_token: 'token'`. Open https://rink.hockeyapp.net/manage/auth_tokens to get one".red unless options[:api_token].to_s.length > 0
-        raise "No IPA file given or found, pass using `ipa: 'path.ipa'`".red unless options[:ipa]
-        raise "IPA file on path '#{File.expand_path(options[:ipa])}' not found".red unless File.exist?(options[:ipa])
-
         if options[:dsym]
-          options[:dsym_filename] = options[:dsym]
+          dsym_filename = options[:dsym]
         else
           dsym_path = options[:ipa].gsub('ipa', 'app.dSYM.zip')
           if File.exist?(dsym_path)
-            options[:dsym_filename] = dsym_path
+            dsym_filename = dsym_path
           else
             Helper.log.info "Symbols not found on path #{File.expand_path(dsym_path)}. Crashes won't be symbolicated properly".yellow
           end
         end
 
-        raise "Symbols on path '#{File.expand_path(options[:dsym_filename])}' not found".red if (options[:dsym_filename] &&
-                                                                                                !File.exist?(options[:dsym_filename]))
+        raise "Symbols on path '#{File.expand_path(dsym_filename)}' not found".red if (dsym_filename &&
+                                                                                                !File.exist?(dsym_filename))
 
         Helper.log.info 'Starting with ipa upload to HockeyApp... this could take some time.'.green
 
@@ -70,12 +58,38 @@ module Fastlane
 
       def self.available_options
         [
-          ['api_token', 'API Token for Hockey Access'],
-          ['ipa', 'Path to the ipa file. Optional if you use the `ipa` or `xcodebuild` action'],
-          ['notes', 'The changelog for this build'],
-          ['dsym', 'Path to the dsym file. Optional if you use the `ipa` or `xcodebuild` action'],
-          ['status', 'Download status: 1 = No user can download; 2 = Available for download'],
-          ['notify', 'Notify testers? 1 for yes'],
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "FL_HOCKEY_API_TOKEN",
+                                       description: "API Token for Hockey Access",
+                                       verify_block: Proc.new do |value|
+                                          raise "No API token for Hockey given, pass using `api_token: 'token'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: "FL_HOCKEY_IPA",
+                                       description: "Path to your IPA file. Optional if you use the `ipa` or `xcodebuild` action",
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
+                                       verify_block: Proc.new do |value|
+                                        raise "No IPA file given or found, pass using `ipa: 'path/app.ipa'`".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dsym,
+                                       env_name: "FL_HOCKEY_DSYM",
+                                       description: "Path to your DSYM file",
+                                       optional: true,
+                                       verify_block: Proc.new do |value|
+                                        # validation is done in the action
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :notes,
+                                       env_name: "FL_HOCKEY_NOTES",
+                                       description: "Beta Notes",
+                                       default_value: "No changelog given"),
+          FastlaneCore::ConfigItem.new(key: :notify,
+                                       env_name: "FL_HOCKEY_NOTIFY",
+                                       description: "Notify testers? 1 for yes",
+                                       default_value: 1),
+          FastlaneCore::ConfigItem.new(key: :status,
+                                       env_name: "FL_HOCKEY_STATUS",
+                                       description: "Download status: 1 = No user can download; 2 = Available for download",
+                                       default_value: "2")
         ]
       end
 

data/lib/fastlane/actions/increment_build_number.rb

@@ -17,22 +17,7 @@ module Fastlane
         # Attention: This is NOT the version number - but the build number
 
         begin
-          first_param = (params.first rescue nil)
-
-          case first_param
-          when NilClass
-            custom_number = nil
-            folder = '.'
-          when Fixnum
-            custom_number = first_param
-            folder = '.'
-          when String
-            custom_number = first_param
-            folder = '.'
-          when Hash
-            custom_number = first_param[:build_number]
-            folder = first_param[:xcodeproj] ? File.join('.', first_param[:xcodeproj], '..') : '.'
-          end
+          folder = params[:xcodeproj] ? File.join('.', params[:xcodeproj], '..') : '.'
             
           command_prefix = [
             'cd',
@@ -43,7 +28,7 @@ module Fastlane
           command = [
             command_prefix,
             'agvtool',
-            custom_number ? "new-version -all #{custom_number}" : 'next-version -all'
+            params[:build_number] ? "new-version -all #{params[:build_number]}" : 'next-version -all'
           ].join(' ')
 
           if Helper.test?
@@ -69,8 +54,18 @@ module Fastlane
 
       def self.available_options
         [
-          ['build_number', 'specify specific build number (optional, omitting it increments by one)'],
-          ['xcodeproj', 'optional, you must specify the path to your main Xcode project if it is not in the project root directory']
+          FastlaneCore::ConfigItem.new(key: :build_number,
+                                       env_name: "FL_BUILD_NUMBER_BUILD_NUMBER",
+                                       description: "Change to a specific version",
+                                       optional: true,
+                                       is_string: 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",
+                                       verify_block: Proc.new do |value|
+                                        raise "Please pass the path to the project, not the workspace".red if value.include?"workspace"
+                                        raise "Could not find Xcode project".red if (not File.exists?(value) and not Helper.is_test?)
+                                       end)
         ]
       end
 

data/lib/fastlane/actions/increment_version_number.rb

@@ -16,34 +16,8 @@ module Fastlane
         # https://developer.apple.com/library/ios/qa/qa1827/_index.html
 
         begin
-          first_param = (params.first rescue nil)
           folder = '.' #Current folder is the default folder
 
-          case first_param
-            when NilClass
-              release_task = 'patch' #Patch is the default action
-            when String
-              release_task = first_param
-            when Hash
-              release_task = first_param[:release_task] ? first_param[:release_task] : "patch"
-              folder = first_param[:xcodeproj] ? File.join('.', first_param[:xcodeproj], '..') : '.'
-          end
-
-          # Verify integrity
-          case release_task
-            when /\d.\d.\d/
-              specific_version_number = release_task
-              release_task = 'specific_version'
-            when "patch"
-              release_task = 'patch'
-            when "minor"
-              release_task = 'minor'
-            when "major"
-              release_task = "major"
-            else
-              raise 'Invalid parameter #{release_task}'
-          end
-
           command_prefix = [
               'cd',
               File.expand_path(folder).shellescape,
@@ -55,7 +29,7 @@ module Fastlane
           else
             current_version = `#{command_prefix} agvtool what-marketing-version -terse1`.split("\n").last
             raise 'Your current version (#{current_version}) does not respect the format A.B.C' unless current_version.match(/\d.\d.\d/)
-            #Check if CFBundleShortVersionString is the same for each occurrence
+            # Check if CFBundleShortVersionString is the same for each occurrence
             allBundles = `#{command_prefix} agvtool what-marketing-version -terse`.split("\n")
             allBundles.each do |bundle|
               raise 'Ensure all you CFBundleShortVersionString are equals in your project ' unless bundle.end_with? "=#{current_version}"
@@ -63,21 +37,26 @@ module Fastlane
             version_array = current_version.split(".").map(&:to_i)
           end
 
-          case release_task
-            when "patch"
-              version_array[2] = version_array[2]+1
-              next_version_number = version_array.join(".")
-            when "minor"
-              version_array[1] = version_array[1]+1
-              version_array[2] = version_array[2]=0
-              next_version_number = version_array.join(".")
-            when "major"
-              version_array[0] = version_array[0]+1
-              version_array[1] = version_array[1]=0
-              version_array[1] = version_array[2]=0
-              next_version_number = version_array.join(".")
-            when "specific_version"
-              next_version_number = specific_version_number
+          if params[:version_number]
+            # Specific version
+            next_version_number = params[:version_number]
+          else
+            case params[:bump_type]
+              when "patch"
+                version_array[2] = version_array[2] + 1
+                next_version_number = version_array.join(".")
+              when "minor"
+                version_array[1] = version_array[1] + 1
+                version_array[2] = version_array[2] = 0
+                next_version_number = version_array.join(".")
+              when "major"
+                version_array[0] = version_array[0] + 1
+                version_array[1] = version_array[1] = 0
+                version_array[1] = version_array[2] = 0
+                next_version_number = version_array.join(".")
+              when "specific_version"
+                next_version_number = specific_version_number
+            end
           end
 
           command = [
@@ -112,8 +91,27 @@ module Fastlane
 
       def self.available_options
         [
-          ['build_number', 'specify specific build number (optional, omitting it increments by one)'],
-          ['xcodeproj', 'optional, you must specify the path to your main Xcode project if it is not in the project root directory']
+          FastlaneCore::ConfigItem.new(key: :bump_type,
+                                       env_name: "FL_VERSION_NUMBER_BUMP_TYPE",
+                                       description: "The type of this version bump. Available: patch, minor, major",
+                                       default_value: "patch",
+                                       verify_block: Proc.new do |value|
+                                        raise "Available values are 'patch', 'minor' and 'major'" unless ['patch', 'minor', 'major'].include?value
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version_number,
+                                       env_name: "FL_VERSION_NUMBER_VERSION_NUMBER",
+                                       description: "Change to a specific version. This will replace the bump type value",
+                                       optional: true, 
+                                       verify_block: Proc.new do |value|
+                                        raise "Invalid version '#{value}' given. Must be x.y.z".red unless value.split(".").count == 3
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_VERSION_NUMBER_PROJECT",
+                                       description: "optional, you must specify the path to your main Xcode project if it is not in the project root directory",
+                                       verify_block: Proc.new do |value|
+                                        raise "Please pass the path to the project, not the workspace".red if value.include?"workspace"
+                                        raise "Could not find Xcode project".red unless File.exists?(value)
+                                       end)
         ]
       end
 

data/lib/fastlane/actions/install_carthage.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     class CarthageAction < Action
-      def self.run(_params)
+      def self.run(params)
         Actions.sh('carthage bootstrap')
       end
 

data/lib/fastlane/actions/install_cocapods.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     class CocoapodsAction < Action
-      def self.run(_params)
+      def self.run(params)
         Actions.sh('pod install')
       end
 

data/lib/fastlane/actions/ipa.rb

@@ -5,20 +5,6 @@ module Fastlane
       DSYM_OUTPUT_PATH = :DSYM_OUTPUT_PATH
     end
 
-    # -w, --workspace                   WORKSPACE Workspace (.xcworkspace) file to use to build app (automatically detected in current directory)
-    # -p, --project PROJECT             Project (.xcodeproj) file to use to build app (automatically detected in current directory, overridden by --workspace option, if passed)
-    # -c, --configuration CONFIGURATION Configuration used to build
-    # -s, --scheme SCHEME               Scheme used to build app
-    # --xcconfig XCCONFIG               use an extra XCCONFIG file to build the app
-    # --xcargs XCARGS                   pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args.
-    # --[no-]clean                      Clean project before building
-    # --[no-]archive                    Archive project after building
-    # -d, --destination DESTINATION     Destination. Defaults to current directory
-    # -m, --embed PROVISION             Sign .ipa file with .mobileprovision
-    # -i, --identity IDENTITY           Identity to be used along with --embed
-    # --sdk SDK                         use SDK as the name or path of the base SDK when building the project
-    # --ipa IPA                         specify the name of the .ipa file to generate (including file extension)
-
     ARGS_MAP = {
       workspace: '-w',
       project: '-p',
@@ -31,6 +17,7 @@ module Fastlane
       identity: '-i',
       sdk: '--sdk',
       ipa: '--ipa',
+      xcconfig: '--xcconfig',
       xcargs: '--xcargs',
     }
 
@@ -48,24 +35,15 @@ module Fastlane
         # The output directory of the IPA and dSYM
         absolute_dest_directory = nil
 
-        params[0] ||= {} # default to hash to fill in default values
-
-        # Allows for a whole variety of configurations
-        if params.first.is_a? Hash
-
-          # Used to get the final path of the IPA and dSYM
-          if dest = params.first[:destination]
-            absolute_dest_directory = Dir.glob(dest).map(&File.method(:realpath)).first
-          end
-
-          # Maps nice developer build parameters to Shenzhen args
-          build_args = params_to_build_args(params.first)
-
-        else
-          build_args = params
+        # Used to get the final path of the IPA and dSYM
+        if dest = params[:destination]
+          absolute_dest_directory = Dir.glob(dest).map(&File.method(:realpath)).first
         end
 
-        unless (params.first[:scheme] rescue nil)
+        # Maps nice developer build parameters to Shenzhen args
+        build_args = params_to_build_args(params)
+
+        unless (params[:scheme] rescue nil)
           Helper.log.warn "You haven't specified a scheme. This might cause problems. If you can't see any outupt, please pass a `scheme`"
         end
 
@@ -96,10 +74,10 @@ module Fastlane
         ENV[SharedValues::DSYM_OUTPUT_PATH.to_s] = absolute_dsym_path
       end
 
-      def self.params_to_build_args(params)
-        # Remove nil value params unless :clean or :archive
-        params = params.delete_if { |k, v| (k != :clean && k != :archive) && v.nil? }
+      def self.params_to_build_args(config)
+        params = config.values
 
+        params = params.delete_if { |k, v| v.nil? }
         params = fill_in_default_values(params)
 
         # Maps nice developer param names to Shenzhen's `ipa build` arguments
@@ -108,6 +86,8 @@ module Fastlane
           if args = ARGS_MAP[k]
             if k == :clean
               v == true ? '--clean' : '--no-clean'
+            elsif k == :archive
+              v == true ? '--archive' : nil
             else
               value = (v.to_s.length > 0 ? "\"#{v}\"" : '')
               "#{ARGS_MAP[k]} #{value}".strip
@@ -143,20 +123,62 @@ module Fastlane
       end
 
       def self.available_options
-        # [
-          # ['workspace', 'Workspace (.xcworkspace) file to use to build app (automatically detected in current directory)'],
-          # ['project', 'Project (.xcodeproj) file to use to build app (automatically detected in current directory'],
-          # ['configuration', 'Configuration used to build'],
-          # ['scheme', 'Scheme used to build app'],
-          # ['clean', 'use an extra XCCONFIG file to build the app'],
-          # ['archive', 'pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args.'],
-          # ['destination', 'Clean project before building'],
-          # ['embed', 'Archive project after building'],
-          # ['identity', 'Destination. Defaults to current directory'],
-          # ['sdk', 'Sign .ipa file with .mobileprovision'],
-          # ['ipa', 'Identity to be used along with --embed'],
-          # ['xcargs', 'specify the name of the .ipa file to generate (including file extension)']
-        # ]
+        [
+          FastlaneCore::ConfigItem.new(key: :workspace,
+                                       env_name: "IPA_WORKSPACE",
+                                       description: "WORKSPACE Workspace (.xcworkspace) file to use to build app (automatically detected in current directory)",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :project,
+                                       env_name: "IPA_PROJECT",
+                                       description: "Project (.xcodeproj) file to use to build app (automatically detected in current directory, overridden by --workspace option, if passed)",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+                                       env_name: "IPA_CONFIGURATION",
+                                       description: "Configuration used to build",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "IPA_SCHEME",
+                                       description: "Scheme used to build app",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :clean,
+                                       env_name: "IPA_CLEAN",
+                                       description: "Clean project before building",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :archive,
+                                       env_name: "IPA_ARCHIVE",
+                                       description: "Archive project after building",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :destination,
+                                       env_name: "IPA_DESTINATION",
+                                       description: "Build destination. Defaults to current directory",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :embed,
+                                       env_name: "IPA_EMBED",
+                                       description: "Sign .ipa file with .mobileprovision",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :identity,
+                                       env_name: "IPA_IDENTITY",
+                                       description: "Identity to be used along with --embed",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :sdk,
+                                       env_name: "IPA_SDK",
+                                       description: "Use SDK as the name or path of the base SDK when building the project",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: "IPA_IPA",
+                                       description: "Specify the name of the .ipa file to generate (including file extension)",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :xcconfig,
+                                       env_name: "IPA_XCCONFIG",
+                                       description: "Use an extra XCCONFIG file to build the app",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :xcargs,
+                                       env_name: "IPA_XCARGS",
+                                       description: "Pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args",
+                                       optional: true),
+        ]
       end
 
       def self.output