fastlane 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb6a1aebf8e3b977e86df84f3bb4a35170c132bb
-  data.tar.gz: ac8ee20aa0a9e140cbabc8347331e28e0bd5964e
+  metadata.gz: 5bfbf28d8f19dd00c13ed6c94a78879a606614eb
+  data.tar.gz: 1dab9f075c9f44962d58eb342fbc191e3832b925
 SHA512:
-  metadata.gz: 85568340077223714e1f952300a53fdcc1bd47bf11e0be964c0c46c3d1087823aec7242b89413fd885df20431a61237f35eef140b85575158c9467187d69e007
-  data.tar.gz: 5bd1d1c69a2a7e7c219bb2eaaa54c3a53bededee928a7a295257f7307d5f763a95c6e0612ad76eecab13ea894d9c01fcb44af74200b6c74b7bc478feeefa4608
+  metadata.gz: 07581ab17b99fa7e2257e7ad87e3da20eade8fe5de023c9fe11326d77ec8dcb76c5005b11f1a657a5e5ffd7079e3761f73185cbd590bd18c0b47a4a1e9a0438a
+  data.tar.gz: a42015506abdd38d372305c95a13cec5edf1f427008f10a3a7775bccd07c1087882c4577bf2ccc7ce97e0f6381f7e553f437806949c2fa30a0fdb2156876a00b

data/bin/fastlane

@@ -28,16 +28,12 @@ class FastlaneApplication
       c.option '--env STRING', String, 'Add environment to use with `dotenv`'
 
       c.action do |args, _options|
-        FastlaneCore::UpdateChecker.start_looking_for_update('fastlane')
-
         if Fastlane::FastlaneFolder.path
           Fastlane::LaneManager.cruise_lanes(args, _options.env)
         else
           create = agree('Could not find fastlane in current directory. Would you like to set it up? (y/n)'.yellow, true)
           Fastlane::Setup.new.run if create
         end
-
-        FastlaneCore::UpdateChecker.show_update_status('fastlane', Fastlane::VERSION)
       end
     end
 
@@ -46,9 +42,7 @@ class FastlaneApplication
       c.description = 'Helps you setting up fastlane based on your existing tools.'
 
       c.action do |_args, _options|
-        FastlaneCore::UpdateChecker.start_looking_for_update('fastlane')
         Fastlane::Setup.new.run
-        FastlaneCore::UpdateChecker.show_update_status('fastlane', Fastlane::VERSION)
       end
     end
 
@@ -61,10 +55,34 @@ class FastlaneApplication
       end
     end
 
+    command :actions do |c|
+      c.syntax = 'fastlane actions'
+      c.description = 'Lists all available fastlane actions'
+
+      c.action do |_args, _options|
+        require 'fastlane/actions_list'
+        Fastlane::ActionsList.run(_args.first)
+      end
+    end
+
+    command :action do |c|
+      c.syntax = 'fastlane action [tool_name]'
+      c.description = 'Shows more information for a specific command'
+      c.action do |_args, _options|
+        require 'fastlane/actions_list'
+        Fastlane::ActionsList.run(_args.first)
+      end
+    end
+
     default_command :run
 
     run!
   end
 end
 
-FastlaneApplication.new.run
+begin
+  # FastlaneCore::UpdateChecker.start_looking_for_update('fastlane')
+  FastlaneApplication.new.run
+ensure
+  FastlaneCore::UpdateChecker.show_update_status('fastlane', Fastlane::VERSION)
+end

data/lib/assets/custom_action_template.rb

@@ -4,14 +4,47 @@ module Fastlane
       [[NAME_UP]]_CUSTOM_VALUE = :[[NAME_UP]]_CUSTOM_VALUE
     end
 
-    class [[NAME_CLASS]]
+    class [[NAME_CLASS]] < Action
       def self.run(params)
         puts "My Ruby Code!"
-        # puts "Parameter: #{params.first}"
+        # puts "Parameter Path: #{params[:first]}"
         # sh "shellcommand ./path"
 
         # Actions.lane_context[SharedValues::[[NAME_UP]]_CUSTOM_VALUE] = "my_val"
       end
+
+
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "A short description with <= 80 characters of what this action does"
+      end
+
+      def self.available_options
+        # Define all options your action supports. 
+        # The environment variable (last parameters) is optional, remove it if you don't need it
+        # You can add as many parameters as you want
+        [
+          ['path', 'Describe what this parameter is useful for', 'ENVIRONMENT_VARIABLE_NAME'],
+          ['second', 'Describe what this parameter is useful for']
+        ]
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+        # Example
+        [
+          ['[[NAME_UP]]_CUSTOM_VALUE', 'A description of what this value contains']
+        ]
+      end
+
+      def self.author
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        '[Your GitHub Name]'
+      end
     end
   end
 end

data/lib/fastlane.rb

@@ -7,13 +7,11 @@ require 'fastlane/setup'
 require 'fastlane/fastlane_folder'
 require 'fastlane/junit_generator'
 require 'fastlane/lane_manager'
+require 'fastlane/action'
 require 'fastlane/actions/actions_helper'
 
 require 'fastlane_core'
 
-# Third Party code
-require 'colored'
-
 module Fastlane
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
 

data/lib/fastlane/action.rb

@@ -0,0 +1,37 @@
+module Fastlane
+  class Action
+    def self.run(params)
+      
+    end
+
+    def self.description
+      "No description provided".red
+    end
+
+    def self.details
+      nil # this is your change to provide a more detailed description of this action
+    end
+
+    def self.available_options
+      # Return an array of 2-3 element arrays, like:
+      # [
+      #   ['app_identifier', 'This value is responsible for X', 'ENVIRONMENT_VARIABLE'],
+      #   ['app_identifier', 'This value is responsible for X']
+      # ]
+      # Take a look at sigh.rb if you're using the config manager of fastlane
+      nil
+    end
+
+    def self.output
+      # Return the keys you provide on the shared area
+      # [
+      #   ['IPA_OUTPUT_PATH', 'The path to the newly generated ipa file']
+      # ]
+      nil
+    end
+
+    def self.author
+      "KrauseFx"
+    end
+  end
+end

data/lib/fastlane/actions/{README → README.md}

@@ -1,3 +1,3 @@
 All the methods, available for the lanes should be created here.
 
-```fastlane``` will automatically detect the files in this folder
+`fastlane` will automatically detect the files in this folder

data/lib/fastlane/actions/add_git_tag.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     # Adds a git tag to the current commit
-    class AddGitTagAction
+    class AddGitTagAction < Action
       def self.run(params)
         params = params.first
 
@@ -17,6 +17,23 @@ module Fastlane
         Helper.log.info 'Adding git tag "#{tag}" 🎯.'
         Actions.sh("git tag #{tag}")
       end
+
+      def self.description
+        "This will add a git tag to the current branch"
+      end
+
+      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']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/cert.rb

@@ -5,38 +5,58 @@ module Fastlane
       CERT_CERTIFICATE_ID = :CERT_CERTIFICATE_ID
     end
 
-    class CertAction
+    class CertAction < Action
       def self.run(params)
         require 'cert'
         require 'cert/options'
 
         return if Helper.test?
 
-        Dir.chdir(FastlaneFolder.path || Dir.pwd) do
-          # This should be executed in the fastlane folder
+        FastlaneCore::UpdateChecker.start_looking_for_update('cert')
 
-          values = params.first
-          unless values.kind_of?Hash
-            # Old syntax
-            values = {}
-            params.each do |val|
-              values[val] = true
+        begin
+          Dir.chdir(FastlaneFolder.path || Dir.pwd) do
+            # This should be executed in the fastlane folder
+
+            values = params.first
+            unless values.kind_of?Hash
+              # Old syntax
+              values = {}
+              params.each do |val|
+                values[val] = true
+              end
             end
-          end
 
-          Cert.config = FastlaneCore::Configuration.create(Cert::Options.available_options, (values || {}))
+            Cert.config = FastlaneCore::Configuration.create(Cert::Options.available_options, (values || {}))
 
-          Cert::CertRunner.run
-          cert_file_path = ENV["CER_FILE_PATH"]
-          certificate_id = ENV["CER_CERTIFICATE_ID"]
-          Actions.lane_context[SharedValues::CERT_FILE_PATH] = cert_file_path
-          Actions.lane_context[SharedValues::CERT_CERTIFICATE_ID] = certificate_id
+            Cert::CertRunner.run
+            cert_file_path = ENV["CER_FILE_PATH"]
+            certificate_id = ENV["CER_CERTIFICATE_ID"]
+            Actions.lane_context[SharedValues::CERT_FILE_PATH] = cert_file_path
+            Actions.lane_context[SharedValues::CERT_CERTIFICATE_ID] = certificate_id
 
-          Helper.log.info("Use signing certificate '#{certificate_id}' from now on!".green)
+            Helper.log.info("Use signing certificate '#{certificate_id}' from now on!".green)
 
-          ENV["SIGH_CERTIFICATE_ID"] = certificate_id
+            ENV["SIGH_CERTIFICATE_ID"] = certificate_id
+          end
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('cert', Cert::VERSION)
         end
       end
+
+      def self.description
+        "Fetch or generate the latest available code signing identity"
+      end
+
+      def self.available_options
+        require 'cert'
+        require 'cert/options'
+        Cert::Options.available_options
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/clean_build_artifacts.rb

@@ -1,6 +1,6 @@
 module Fastlane
   module Actions
-    class CleanBuildArtifactsAction
+    class CleanBuildArtifactsAction < Action
       def self.run(_params)
         [
           Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH],
@@ -10,6 +10,14 @@ module Fastlane
 
         Helper.log.info 'Cleaned up build artifacts 🐙'.green
       end
+
+      def self.description
+        "Deletes files created as result of running ipa or sigh"
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/commit_version_bump.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     # Commits the current changes in the repo as a version bump, checking to make sure only files which contain version information have been changed.
-    class CommitVersionBumpAction
+    class CommitVersionBumpAction < Action
       def self.run(params)
         require 'xcodeproj'
         require 'pathname'
@@ -74,6 +74,21 @@ module Fastlane
 
         Helper.log.info "Committed \"#{commit_message}\" 💾.".green
       end
+
+      def self.description
+        "Creates a 'Version Bump' commit. Run after `increment_build_number`"
+      end
+
+      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']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/crashlytics.rb

@@ -4,7 +4,7 @@ end
 
 module Fastlane
   module Actions
-    class CrashlyticsAction
+    class CrashlyticsAction < Action
       def self.run(params)
         require 'shenzhen'
         require 'shenzhen/plugins/crashlytics'
@@ -83,6 +83,26 @@ module Fastlane
         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']
+        ]
+      end
+
+      def self.author
+        "pedrogimenez"
+      end
+
       private_class_method :assert_params_given!,
                            :assert_valid_params!,
                            :assert_valid_crashlytics_path!,

data/lib/fastlane/actions/deliver.rb

@@ -3,29 +3,47 @@ module Fastlane
     module SharedValues
     end
 
-    class DeliverAction
+    class DeliverAction < Action
       def self.run(params)
         require 'deliver'
 
         FastlaneCore::UpdateChecker.start_looking_for_update('deliver')
 
-        ENV['DELIVER_SCREENSHOTS_PATH'] = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
+        begin
+          ENV['DELIVER_SCREENSHOTS_PATH'] = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
 
-        force = params.include?(:force)
-        beta = params.include?(:beta)
-        skip_deploy = params.include?(:skip_deploy)
+          force = params.include?(:force)
+          beta = params.include?(:beta)
+          skip_deploy = params.include?(:skip_deploy)
 
-        Dir.chdir(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)
+          Dir.chdir(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)
 
-          Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] = File.expand_path(ENV['DELIVER_IPA_PATH']) # deliver will store it in the environment
+            Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] = File.expand_path(ENV['DELIVER_IPA_PATH']) # deliver will store it in the environment
+          end
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('deliver', Deliver::VERSION)
         end
+      end
+
+      def self.description
+        "Uses deliver to upload new app metadata and builds to iTunes Connect"
+      end
+
+      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'],
+        ]
+      end
 
-        FastlaneCore::UpdateChecker.show_update_status('deliver', Deliver::VERSION)
+      def self.author
+        "KrauseFx"
       end
     end
   end

data/lib/fastlane/actions/deploygate.rb

@@ -10,7 +10,7 @@ module Fastlane
       DEPLOYGATE_APP_INFO = :DEPLOYGATE_APP_INFO # contains app revision, bundle identifier, etc.
     end
 
-    class DeploygateAction
+    class DeploygateAction < Action
       DEPLOYGATE_URL_BASE = 'https://deploygate.com'
 
       def self.run(params)
@@ -83,6 +83,31 @@ module Fastlane
         Helper.log.error message.red if message
       end
       private_class_method :help_message
+
+      def self.description
+        "Upload a new build to DeployGate"
+      end
+
+      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']
+        ]
+      end
+
+      def self.output
+        [
+          ['DEPLOYGATE_URL', 'URL of the newly uploaded build'],
+          ['DEPLOYGATE_REVISION', 'auto incremented revision number'],
+          ['DEPLOYGATE_APP_INFO', 'Contains app revision, bundle identifier, etc.']
+        ]
+      end
+
+      def self.author
+        "tnj"
+      end
     end
   end
 end