fastlane 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cbac227e095ab139acfcf394f2607bb1da0ae82
-  data.tar.gz: 7f41df9446553d5c0bf1d1ead4a872cbdb169933
+  metadata.gz: b6af986f5285287dc4be0672d7567284e404ad1f
+  data.tar.gz: 349556bcb8ecd9755d3276a1691c14e3fe423e43
 SHA512:
-  metadata.gz: cffeeee93a8a855fb5f5c5dca44cba393c0304d4a2b9c79816ec4107835f997ae1112fd9b3f324a7a919a91a142cf7fb7f7685b246cb705239252ca35db13378
-  data.tar.gz: 1752557d250037e80eb7b583050aa24226cb1875d85420fd4b8cbe45a09fb73c5f9bd764f4e1eb7bb29723adf9777059d497bee919b4b5050998b3693412c78a
+  metadata.gz: c28b00dfefe71736fefdedc38cf21f224113e2f66a7f2b9ec80c9c08012251c167fd05e5c3e53a8183b3a086ccc421b055e4cde9cd8202f39f9d6ebcaa00d080
+  data.tar.gz: 26a97d1667f249374d9cdc7338a3344305fb8698dc613c8a5483a4eeb508357e0b4a891e50ce694741d9ffb374c893872a2b9f2bac5c6b3c7bc36e4b0564c0cd

data/lib/assets/FastfileTemplate

@@ -9,6 +9,9 @@
 # Uncomment the following line to opt out
 # opt_out_usage
 
+# If you want to automatically update fastlane if a new version is available:
+# update_fastlane
+
 # This is the minimum version number required.
 # Update this, if you use features of a newer version
 fastlane_version "[[FASTLANE_VERSION]]"

data/lib/fastlane.rb

@@ -11,6 +11,7 @@ require 'fastlane/action'
 require 'fastlane/actions/actions_helper'
 require 'fastlane/action_collector'
 require 'fastlane/supported_platforms'
+require 'fastlane/configuration_helper'
 
 require 'fastlane_core'
 

data/lib/fastlane/action.rb

@@ -54,5 +54,10 @@ module Fastlane
     def self.sh(command)
       Fastlane::Actions.sh(command)
     end
+
+    # instead of "AddGitAction", this will return "add_git" to print it to the user
+    def self.action_name
+      self.name.split('::').last.gsub('Action', '').fastlane_underscore
+    end
   end
 end

data/lib/fastlane/action_collector.rb

@@ -33,7 +33,9 @@ module Fastlane
                   error: @error
                 )
 
-          Excon.post(url)
+          unless Helper.is_test? # don't send test data
+            Excon.post(url)
+          end
         end
       end
     end

data/lib/fastlane/actions/actions_helper.rb

@@ -17,6 +17,11 @@ module Fastlane
       @lane_context ||= {}
     end
 
+    # Used in tests to get a clear lane before every test
+    def self.clear_lane_context
+      @lane_context = nil
+    end
+
     # Pass a block which should be tracked. One block = one testcase
     # @param step_name (String) the name of the currently built code (e.g. snapshot, sigh, ...)
     def self.execute_action(step_name)

data/lib/fastlane/actions/add_git_tag.rb

@@ -2,19 +2,12 @@ module Fastlane
   module Actions
     # Adds a git tag to the current commit
     class AddGitTagAction < Action
-      def self.run(params)
-        params = params.first
+      def self.run(options)
+        lane_name = Actions.lane_context[Actions::SharedValues::LANE_NAME].gsub(' ', '') # no spaces allowed
 
-        specified_tag = (params && params[:tag])
-        grouping      = (params && params[:grouping]) || 'builds'
-        prefix        = (params && params[:prefix]) || ''
-        build_number  = (params && params[:build_number]) || Actions.lane_context[Actions::SharedValues::BUILD_NUMBER]
-        
-        lane_name     = Actions.lane_context[Actions::SharedValues::LANE_NAME]
+        tag = options[:tag] || "#{options[:grouping]}/#{lane_name}/#{options[:prefix]}#{options[:build_number].to_s}"
 
-        tag = specified_tag || "#{grouping}/#{lane_name}/#{prefix}#{build_number}"
-
-        Helper.log.info 'Adding git tag "#{tag}" 🎯.'
+        Helper.log.info "Adding git tag '#{tag}' 🎯."
         Actions.sh("git tag #{tag}")
       end
 
@@ -24,10 +17,23 @@ module Fastlane
 
       def self.available_options
         [
-          ['tag', 'Define your own tag text. This will replace all other parameters.'],
-          ['grouping', 'Is used to keep your tags organised under one "folder". Defaults to "builds"'],
-          ['prefix', 'Anything you want to put in front of the version number (e.g. "v").'],
-          ['build_number', 'The build number. Defaults to the result of increment_build_number if you\'re using it']
+          FastlaneCore::ConfigItem.new(key: :tag,
+                                       env_name: "FL_GIT_TAG_TAG",
+                                       description: "Define your own tag text. This will replace all other parameters",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :grouping,
+                                       env_name: "FL_GIT_TAG_GROUPING",
+                                       description: "Is used to keep your tags organised under one 'folder'. Defaults to 'builds'",
+                                       default_value: 'builds'),
+          FastlaneCore::ConfigItem.new(key: :prefix,
+                                       env_name: "FL_GIT_TAG_PREFIX",
+                                       description: "Anything you want to put in front of the version number (e.g. 'v')",
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :build_number,
+                                       env_name: "FL_GIT_TAG_BUILD_NUMBER",
+                                       description: "The build number. Defaults to the result of increment_build_number if you\'re using it",
+                                       default_value: Actions.lane_context[Actions::SharedValues::BUILD_NUMBER],
+                                       is_string: false)
         ]
       end
 

data/lib/fastlane/actions/cert.rb

@@ -12,7 +12,7 @@ module Fastlane
 
         return if Helper.test?
 
-        FastlaneCore::UpdateChecker.start_looking_for_update('cert')
+        FastlaneCore::UpdateChecker.start_looking_for_update('cert') unless Helper.is_test?
 
         begin
           Dir.chdir(FastlaneFolder.path || Dir.pwd) do
@@ -37,7 +37,7 @@ module Fastlane
 
             Helper.log.info("Use signing certificate '#{certificate_id}' from now on!".green)
 
-            ENV["SIGH_CERTIFICATE_ID"] = certificate_id
+            ENV["SIGH_CERTIFICATE_ID"] = certificate_id # for further use in the sigh action
           end
         ensure
           FastlaneCore::UpdateChecker.show_update_status('cert', Cert::VERSION)

data/lib/fastlane/actions/clean_build_artifacts.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     class CleanBuildArtifactsAction < Action
-      def self.run(_params)
+      def self.run(params)
         [
           Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH],
           Actions.lane_context[Actions::SharedValues::SIGH_PROFILE_PATH],

data/lib/fastlane/actions/commit_version_bump.rb

@@ -8,10 +8,7 @@ module Fastlane
         require 'set'
         require 'shellwords'
 
-        params = params.first
-
-        commit_message = (params && params[:message]) || 'Version Bump'
-        xcodeproj_path = (params && params[:xcodeproj]) ? File.expand_path(File.join('.', params[:xcodeproj])) : nil
+        xcodeproj_path = params[:xcodeproj] ? File.expand_path(File.join('.', params[:xcodeproj])) : nil
 
         # find the repo root path
         repo_path = `git rev-parse --show-toplevel`.strip
@@ -70,9 +67,9 @@ module Fastlane
 
         # then create a commit with a message
         Actions.sh("git add #{git_add_paths.map(&:shellescape).join(' ')}")
-        Actions.sh("git commit -m '#{commit_message}'")
+        Actions.sh("git commit -m '#{params[:message]}'")
 
-        Helper.log.info "Committed \"#{commit_message}\" 💾.".green
+        Helper.log.info "Committed \"#{params[:message]}\" 💾.".green
       end
 
       def self.description
@@ -81,8 +78,18 @@ module Fastlane
 
       def self.available_options
         [
-          ['message', 'The commit message. Defaults to "Version Bump"'],
-          ['xcodeproj', 'The path to your project file (Not the workspace). If you have only one, this is optional']
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_COMMIT_BUMP_MESSAGE",
+                                       description: "The commit message when committing the version bump",
+                                       default_value: "Version Bump"),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_BUILD_NUMBER_PROJECT",
+                                       description: "The path to your project file (Not the workspace). If you have only one, this is optional",
+                                       optional: true,
+                                       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/crashlytics.rb

@@ -13,19 +13,7 @@ module Fastlane
       def self.run(params)
         require 'shenzhen'
         require 'shenzhen/plugins/crashlytics'
-
-        assert_params_given!(params)
-
-        params = params.first
-
-        crashlytics_path = params[:crashlytics_path] || ENV["CRASHLYTICS_FRAMEWORK_PATH"]
-        api_token        = params[:api_token] || ENV["CRASHLYTICS_API_TOKEN"]
-        build_secret     = params[:build_secret] || ENV["CRASHLYTICS_BUILD_SECRET"]
-        ipa_path         = params[:ipa_path] || Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-        notes_path       = params[:notes_path]
-        emails           = params[:emails]
-        notifications    = params[:notifications]
-
+        
         # can pass groups param either as an Array or a String
         case params[:groups]
         when NilClass
@@ -36,15 +24,16 @@ module Fastlane
           groups = params[:groups]
         end
 
-        assert_valid_params!(crashlytics_path, api_token, build_secret, ipa_path)
-
         Helper.log.info 'Uploading the IPA to Crashlytics. Go for a coffee ☕️.'.green
 
-        return if Helper.test?
+        if Helper.test?
+          # Access all values, to do the verify
+          return params[:crashlytics_path], params[:api_token], params[:build_secret], params[:ipa_path], params[:build_secret], params[:ipa_path], params[:notes_path], params[:emails], params[:groups], params[:notifications]
+        end
 
-        client = Shenzhen::Plugins::Crashlytics::Client.new(crashlytics_path, api_token, build_secret)
+        client = Shenzhen::Plugins::Crashlytics::Client.new(params[:crashlytics_path], params[:api_token], params[:build_secret])
 
-        response = client.upload_build(ipa_path, file: ipa_path, notes: notes_path, emails: emails, groups: groups, notifications: notifications)
+        response = client.upload_build(ipa_path, file: params[:ipa_path], notes: params[:notes_path], emails: params[:emails], groups: params[:groups], notifications: params[:notifications])
 
         if response
           Helper.log.info 'Build successfully uploaded to Crashlytics'.green
@@ -54,66 +43,62 @@ module Fastlane
         end
       end
 
-      private
-
-      def self.assert_params_given!(params)
-        return unless params.empty?
-        raise 'You have to pass Crashlytics parameters to the Crashlytics action, take a look at https://github.com/KrauseFx/fastlane#crashlytics'.red
-      end
-
-      def self.assert_valid_params!(crashlytics_path, api_token, build_secret, ipa_path)
-        assert_valid_crashlytics_path!(crashlytics_path)
-        assert_valid_api_token!(api_token)
-        assert_valid_build_secret!(build_secret)
-        assert_valid_ipa_path!(ipa_path)
-      end
-
-      def self.assert_valid_crashlytics_path!(crashlytics_path)
-        return if crashlytics_path && File.exist?(crashlytics_path)
-        raise "No Crashlytics path given or found, pass using `crashlytics_path: 'path'`".red
-      end
-
-      def self.assert_valid_api_token!(token)
-        return unless token.nil? || token.empty?
-        raise "No API token for Crashlytics given, pass using `api_token: 'token'`".red
-      end
-
-      def self.assert_valid_build_secret!(build_secret)
-        return unless build_secret.nil? || build_secret.empty?
-        raise "No build secret for Crashlytics given, pass using `build_secret: 'secret'`".red
-      end
-
-      def self.assert_valid_ipa_path!(ipa_path)
-        return if ipa_path && File.exist?(ipa_path)
-        raise "No IPA file given or found, pass using `ipa_path: 'path/app.ipa'`".red
-      end
-
       def self.description
         "Upload a new build to Crashlytics Beta"
       end
 
       def self.available_options
         [
-          ['crashlytics_path', 'Path to your Crashlytics bundle', 'CRASHLYTICS_FRAMEWORK_PATH'],
-          ['api_token', 'Crashlytics Beta API Token', 'CRASHLYTICS_API_TOKEN'],
-          ['build_secret', 'Crashlytics Build Secret', 'CRASHLYTICS_BUILD_SECRET'],
-          ['ipa_path', 'Path to your IPA file. Optional if you use the `ipa` or `xcodebuild` action'],
-          ['notes_path', 'Release Notes'],
-          ['emails', 'Pass email address'],
-          ['notifications', 'Crashlytics notification option']
+          FastlaneCore::ConfigItem.new(key: :crashlytics_path,
+                                       env_name: "CRASHLYTICS_FRAMEWORK_PATH",
+                                       description: "Path to your Crashlytics bundle",
+                                       verify_block: Proc.new do |value|
+                                        raise "No Crashlytics path given or found, pass using `crashlytics_path: 'path'`".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CRASHLYTICS_API_TOKEN",
+                                       description: "Crashlytics Beta API Token",
+                                       verify_block: Proc.new do |value|
+                                          raise "No API token for Crashlytics given, pass using `api_token: 'token'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :build_secret,
+                                       env_name: "CRASHLYTICS_BUILD_SECRET",
+                                       description: "Crashlytics Build Secret",
+                                       verify_block: Proc.new do |value|
+                                        raise "No build secret for Crashlytics given, pass using `build_secret: 'secret'`".red unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ipa_path,
+                                       env_name: "CRASHLYTICS_IPA_PATH",
+                                       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: 'path/app.ipa'`".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :notes_path,
+                                       env_name: "CRASHLYTICS_NOTES_PATH",
+                                       description: "Path to the release notes",
+                                       optional: true,
+                                       verify_block: Proc.new do |value|
+                                        raise "Path '#{value}' not found".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :groups,
+                                       env_name: "CRASHLYTICS_GROUPS",
+                                       description: "The groups used for distribution",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :emails,
+                                       env_name: "CRASHLYTICS_EMAILS",
+                                       description: "Pass email addresses, separated by commas",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :notifications,
+                                       env_name: "CRASHLYTICS_NOTIFICATIONS",
+                                       description: "Crashlytics notification option (true/false)",
+                                       optional: true)
         ]
       end
 
       def self.author
         "pedrogimenez"
       end
-
-      private_class_method :assert_params_given!,
-                           :assert_valid_params!,
-                           :assert_valid_crashlytics_path!,
-                           :assert_valid_api_token!,
-                           :assert_valid_build_secret!,
-                           :assert_valid_ipa_path!
     end
   end
 end

data/lib/fastlane/actions/deliver.rb

@@ -4,24 +4,20 @@ module Fastlane
     end
 
     class DeliverAction < Action
-      def self.run(params)
+      def self.run(config)
         require 'deliver'
 
-        FastlaneCore::UpdateChecker.start_looking_for_update('deliver')
+        FastlaneCore::UpdateChecker.start_looking_for_update('deliver') unless Helper.is_test?
 
         begin
-          ENV['DELIVER_SCREENSHOTS_PATH'] = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
+          ENV['DELIVER_SCREENSHOTS_PATH'] = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] # use snapshot's screenshots if there
 
-          force = params.include?(:force)
-          beta = params.include?(:beta)
-          skip_deploy = params.include?(:skip_deploy)
-
-          Dir.chdir(ENV["DELIVERFILE_PATH"] || FastlaneFolder.path || Dir.pwd) do
+          Dir.chdir(config[:deliver_file_path] || FastlaneFolder.path || Dir.pwd) do
             # This should be executed in the fastlane folder
             Deliver::Deliverer.new(nil,
-                                   force: force,
-                                   is_beta_ipa: beta,
-                                   skip_deploy: skip_deploy)
+                                   force: config[:force],
+                                   is_beta_ipa: config[:beta],
+                                   skip_deploy: config[:skip_deploy])
 
             if ENV['DELIVER_IPA_PATH'] # since IPA upload is optional
               Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] = File.expand_path(ENV['DELIVER_IPA_PATH']) # deliver will store it in the environment
@@ -38,10 +34,31 @@ module Fastlane
 
       def self.available_options
         [
-          ['force', 'Set to true to skip PDF verification'],
-          ['beta', 'Upload a new version to TestFlight'],
-          ['skip_deploy', 'Skip the submission of the app - it will only be uploaded'],
-          ['', 'Specify a path to the directory containing the Deliverfile', 'DELIVERFILE_PATH']
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: "FL_DELIVER_FORCE",
+                                       description: "Set to true to skip PDF verification",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :beta,
+                                       env_name: "FL_DELIVER_BETA",
+                                       description: "Upload a new version to TestFlight",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :skip_deploy,
+                                       env_name: "FL_DELIVER_SKIP_DEPLOY",
+                                       description: "Skip the submission of the app - it will only be uploaded",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :deliver_file_path,
+                                       env_name: "FL_DELIVER_CONFIG_PATH",
+                                       description: "Specify a path to the directory containing the Deliverfile",
+                                       default_value: FastlaneFolder.path || Dir.pwd, # defaults to fastlane folder
+                                       verify_block: Proc.new do |value|
+                                        raise "Couldn't find folder '#{value}'. Make sure to pass the path to the directory not the file!".red unless File.directory?(value)
+                                       end)
         ]
       end
 

data/lib/fastlane/actions/deploygate.rb

@@ -17,25 +17,21 @@ module Fastlane
         platform == :ios
       end
 
-      def self.run(params)
+      def self.run(options)
         require 'shenzhen'
         require 'shenzhen/plugins/deploygate'
 
         # Available options: https://deploygate.com/docs/api
-        options = {
-          ipa: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-        }.merge(params.first || {})
-        assert_options!(options)
-
         Helper.log.info 'Starting with ipa upload to DeployGate... this could take some time ⏳'.green
+
         client = Shenzhen::Plugins::DeployGate::Client.new(
-          options.delete(:api_token),
-          options.delete(:user)
+          options[:api_token],
+          options[:user]
         )
 
-        return if Helper.test?
+        return options[:ipa] if Helper.test?
 
-        response = client.upload_build(options.delete(:ipa), options)
+        response = client.upload_build(options[:ipa], options)
         if parse_response(response)
           Helper.log.info "DeployGate URL: #{Actions.lane_context[SharedValues::DEPLOYGATE_URL]}"
           Helper.log.info "Build successfully uploaded to DeployGate as revision \##{Actions.lane_context[SharedValues::DEPLOYGATE_REVISION]}!".green
@@ -44,14 +40,6 @@ module Fastlane
         end
       end
 
-      def self.assert_options!(options)
-        raise "No API Token for DeployGate given, pass using `api_token: 'token'`".red unless options[:api_token].to_s.length > 0
-        raise "No User for app given, pass using `user: 'user'`".red unless options[:user].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])
-      end
-      private_class_method :assert_options!
-
       def self.parse_response(response)
         if response.body && response.body.key?('error')
           unless response.body['error']
@@ -94,10 +82,29 @@ module Fastlane
 
       def self.available_options
         [
-          ['api_token', 'DeployGate API Token'],
-          ['user', 'Target username or organization name'],
-          ['ipa', 'Path to your IPA file. Defaults to output of xcodebuild and ipa'],
-          ['message', 'Text for the uploaded build']
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "DEPLOYGATE_API_TOKEN",
+                                       description: "Deploygate API Token",
+                                       verify_block: Proc.new do |value|
+                                          raise "No API Token for DeployGate given, pass using `api_token: 'token'`".red unless value.to_s.length > 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :user,
+                                       env_name: "DEPLOYGATE_USER",
+                                       description: "Target username or organization name", 
+                                       verify_block: Proc.new do |value|
+                                        raise "No User for app given, pass using `user: 'user'`".red unless value.to_s.length > 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: "DEPLOYGATE_IPA_PATH",
+                                       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.ipa'`".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "DEPLOYGATE_MESSAGE",
+                                       description: "Release Notes",
+                                       default_value: "No changelog provided")
         ]
       end