fastlane 0.6.1 → 0.7.0

data/lib/fastlane/actions/produce.rb

@@ -4,7 +4,7 @@ module Fastlane
       PRODUCE_APPLE_ID = :PRODUCE_APPLE_ID
     end
 
-    class ProduceAction
+    class ProduceAction < Action
       def self.run(params)
         require 'produce'
 
@@ -17,18 +17,60 @@ module Fastlane
 
         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('produce')
 
-          CredentialsManager::PasswordManager.shared_manager(ENV['PRODUCE_USERNAME']) if ENV['PRODUCE_USERNAME']
-          Produce::Config.shared_config # to ask for missing information right in the beginning
+        begin
+          Dir.chdir(FastlaneFolder.path || Dir.pwd) do
+            # This should be executed in the fastlane folder
 
-          apple_id = Produce::Manager.start_producing.to_s
+            CredentialsManager::PasswordManager.shared_manager(ENV['PRODUCE_USERNAME']) if ENV['PRODUCE_USERNAME']
+            Produce::Config.shared_config # to ask for missing information right in the beginning
 
-          Actions.lane_context[SharedValues::PRODUCE_APPLE_ID] = apple_id
-          ENV['PRODUCE_APPLE_ID'] = apple_id
+            apple_id = Produce::Manager.start_producing.to_s
+
+            Actions.lane_context[SharedValues::PRODUCE_APPLE_ID] = apple_id
+            ENV['PRODUCE_APPLE_ID'] = apple_id
+          end
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('produce', Produce::VERSION)
         end
       end
+
+      def self.description
+        "Makes sure the given app identifier is created on the Dev Portal"
+      end
+
+      def details
+        [
+          'For more information about produce, visit its GitHub page:',
+          'https://github.com/KrauseFx/produce'
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          ['produce_app_identifier', 'The App Identifier of your app', 'PRODUCE_APP_IDENTIFIER'],
+          ['produce_app_name', 'The name of your app', 'PRODUCE_APP_NAME'],
+          ['produce_language', 'The app\'s default language', 'PRODUCE_LANGUAGE'],
+          ['produce_version', 'The initial version of your app', 'PRODUCE_VERSION'],
+          ['produce_sku', 'The SKU number of the app if it gets created', 'PRODUCE_SKU'],
+          ['produce_team_name', 'optional: the name of your team', 'PRODUCE_TEAM_NAME'],
+          ['produce_team_id', 'optional: the ID of your team', 'PRODUCE_TEAM_ID'],
+          ['produce_username', 'optional: your Apple ID', 'PRODUCE_USERNAME'],
+          ['skip_itc', 'Skip the creation on iTunes Connect', 'PRODUCE_SKIP_ITC'],
+          ['skip_devcenter', 'Skip the creation on the Apple Developer Portal', 'PRODUCE_SKIP_DEVCENTER']
+        ]
+      end
+
+      def self.output
+        [
+          ['PRODUCE_APPLE_ID', 'The Apple ID of the newly created app. You probably need it for `deliver`']
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/push_to_git_remote.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     # Adds a git tag to the current commit
-    class PushToGitRemoteAction
+    class PushToGitRemoteAction < Action
       def self.run(params)
         options = params.first
 
@@ -28,6 +28,23 @@ module Fastlane
 
         Helper.log.info 'Sucesfully pushed to remote.'
       end
+
+      def self.description
+        "Push local changes to the remote branch"
+      end
+
+      def self.available_options
+        [
+          ['remote', 'The remote to push to. Defaults to `origin`'],
+          ['branch', 'The local branch to push from. Defaults to the current branch'],
+          ['branch', 'The remote branch to push to. Defaults to the local branch'],
+          ['force', 'Force push to remote. Defaults to false']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/register_devices.rb

@@ -1,6 +1,6 @@
 module Fastlane
   module Actions
-    class RegisterDevicesAction
+    class RegisterDevicesAction < Action
       UDID_REGEXP = /^\h{40}$/
 
       def self.run(params)
@@ -58,6 +58,23 @@ module Fastlane
           Helper.log.info "Device list up to date, all #{device_objs.count} devices are already registered. Total devices registed: #{existing_devices.count}.".green
         end
       end
+
+      def self.description
+        "Registers new devices to the Apple Dev Portal"
+      end
+
+      def self.available_options
+        [
+          ['devices', 'A hash of devices, with the name as key and the UDID as value'],
+          ['device_file', 'Instead, you can proide a path containing all UDIDs'],
+          ['team_id', 'optional: Your team ID'],
+          ['username', 'optional: Your Apple ID']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/reset_git_repo.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     # Does a hard reset and clean on the repo
-    class ResetGitRepoAction
+    class ResetGitRepoAction < Action
       def self.run(params)
         hash = params.first
         if params.include?(:force) || hash[:force] || Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START]
@@ -22,6 +22,29 @@ module Fastlane
           raise 'This is a destructive and potentially dangerous action. To protect from data loss, please add the `ensure_git_status_clean` action to the beginning of your lane, or if you\'re absolutely sure of what you\'re doing then call this action with the :force option.'.red
         end
       end
+
+      def self.description
+        "Resets git repo to a clean state by discarding uncommited changes"
+      end
+
+      def self.details
+        [
+          "This action will reset your git repo to a clean state, discarding any uncommitted and untracked changes. Useful in case you need to revert the repo back to a clean state, e.g. after the fastlane run.",
+          "It's a pretty drastic action so it comes with a sort of safety latch. It will only proceed with the reset if either of these conditions are met:",
+          "You have called the ensure_git_status_clean action prior to calling this action. This ensures that your repo started off in a clean state, so the only things that will get destroyed by this action are files that are created as a byproduct of the fastlane run."
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          ['files', 'Array of files the changes should be discarded from. If not given, all files will be discarded'],
+          ['force', 'Skip verifying of previously clean state of repo. Only recommended in combination with `files` option']
+        ]
+      end
+
+      def self.author
+        'lmirosevic'
+      end
     end
   end
 end

data/lib/fastlane/actions/resign.rb

@@ -1,7 +1,7 @@
 module Fastlane
   module Actions
     # Resigns the ipa
-    class ResignAction
+    class ResignAction < Action
       def self.run(params)
         require 'sigh'
 
@@ -24,6 +24,22 @@ module Fastlane
           raise 'Failed to re-sign .ipa'.red
         end
       end
+
+      def self.description
+        "Code sign an existing API"
+      end
+
+      def self.available_options
+        [
+          ['ipa', 'Path to the ipa file to resign. Optional if you use the `ipa` or `xcodebuild` action'],
+          ['signing_identity', 'Code signing identity to use. e.g. "iPhone Distribution: Luka Mirosevic (0123456789)"'],
+          ['provisioning_profile', 'Path to your provisioning_profile. Optional if you use `sigh`']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/s3.rb

@@ -36,7 +36,7 @@ module Fastlane
       path: '-P',
     }
 
-    class S3Action
+    class S3Action < Action
       def self.run(params)
         
         params[0] ||= {}
@@ -241,8 +241,36 @@ module Fastlane
         return bundle_id, bundle_version, title
       end
 
-    end
+      def self.description
+        "Generates a plist file and uploads all to AWS S3"
+      end
+
+      def self.available_options
+        [
+          ['access_key', 'AWS S3 Access Key', 'S3_ACCESS_KEY'],
+          ['secret_access_key', 'AWS S3 Secret Key', 'S3_SECRET_ACCESS_KEY'],
+          ['bucket', 'The bucket to store the ipa and plist in', 'S3_BUCKET'],
+          ['region', 'The region of your S3 server', 'S3_REGION'],
+          ['file', 'Path the ipa file to upload'],
+          ['dsym', 'Path to your dsym file'],
+          ['path', 'The path how it\'s used on S3']
+          # TODO: there are more options
+        ]
+      end
 
+      def self.output
+        [
+          ['S3_IPA_OUTPUT_PATH', 'Direct HTTP link to the uploaded ipa file'],
+          ['S3_DSYM_OUTPUT_PATH', 'Direct HTTP link to the uploaded dsym file'],
+          ['S3_PLIST_OUTPUT_PATH', 'Direct HTTP link to the uploaded plist file'],
+          ['S3_HTML_OUTPUT_PATH', 'Direct HTTP link to the uploaded HTML file']
+        ]
+      end
+
+      def self.author
+        "joshdholtz"
+      end
+    end
   end
 end
 

data/lib/fastlane/actions/say.rb

@@ -1,10 +1,14 @@
 module Fastlane
   module Actions
-    class SayAction
+    class SayAction < Action
       def self.run(params)
         text = params.join(' ')
         Actions.sh("say '#{text}'")
       end
+
+      def self.description
+        "This action speaks out loud the given text"
+      end
     end
   end
 end

data/lib/fastlane/actions/sigh.rb

@@ -5,7 +5,7 @@ module Fastlane
       SIGH_UDID = :SIGH_UDID
     end
 
-    class SighAction
+    class SighAction < Action
       def self.run(params)
         require 'sigh'
         require 'sigh/options'
@@ -22,12 +22,28 @@ module Fastlane
           end
         end
 
-        Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, (values || {}))
-        
-        path = Sigh::Manager.start
+        begin
+          FastlaneCore::UpdateChecker.start_looking_for_update('sigh')
 
-        Actions.lane_context[SharedValues::SIGH_PROFILE_PATH] = path # absolute path
-        Actions.lane_context[SharedValues::SIGH_UDID] = ENV["SIGH_UDID"] if ENV["SIGH_UDID"] # The UDID of the new profile
+          Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, (values || {}))
+          
+          path = Sigh::Manager.start
+
+          Actions.lane_context[SharedValues::SIGH_PROFILE_PATH] = path # absolute path
+          Actions.lane_context[SharedValues::SIGH_UDID] = ENV["SIGH_UDID"] if ENV["SIGH_UDID"] # The UDID of the new profile
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('sigh', Sigh::VERSION)
+        end
+      end
+
+      def self.description
+        "Generates a provisioning profile. Stores the profile in the current folder"
+      end
+
+      def self.available_options
+        require 'sigh'
+        require 'sigh/options'
+        Sigh::Options.available_options
       end
     end
   end

data/lib/fastlane/actions/slack.rb

@@ -1,9 +1,6 @@
 module Fastlane
   module Actions
-    module SharedValues
-    end
-
-    class SlackAction
+    class SlackAction < Action
       def self.git_author
         s = `git log --name-status HEAD^..HEAD`
         s = s.match(/Author:.*<(.*)>/)[1]
@@ -125,6 +122,24 @@ module Fastlane
           Helper.log.info 'Successfully sent Slack notification'.green
         end
       end
+
+      def self.description
+        "Send a success/error message to your Slack group"
+      end
+
+      def self.available_options
+        [
+          ['message', 'The message that should be displayed on Slack. This supports the standard Slack markup language'],
+          ['channel', '#channel or @username'],
+          ['success', 'Success or error?'],
+          ['payload', 'Add additional information to this post. payload must be a hash containg any key with any value'],
+          ['default_payloads', 'Remove some of the default payloads. More information about the available payloads GitHub']
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/snapshot.rb

@@ -4,7 +4,7 @@ module Fastlane
       SNAPSHOT_SCREENSHOTS_PATH = :SNAPSHOT_SCREENSHOTS_PATH
     end
 
-    class SnapshotAction
+    class SnapshotAction < Action
       def self.run(params)
         clean = true
         clean = false if params.include?(:noclean)
@@ -17,15 +17,36 @@ module Fastlane
 
         require 'snapshot'
 
-        Dir.chdir(FastlaneFolder.path) do
-          Snapshot::SnapshotConfig.shared_instance
-          Snapshot::Runner.new.work(clean: clean)
+        FastlaneCore::UpdateChecker.start_looking_for_update('snapshot')
 
-          results_path = Snapshot::SnapshotConfig.shared_instance.screenshots_path
+        begin
+          Dir.chdir(FastlaneFolder.path) do
+            Snapshot::SnapshotConfig.shared_instance
+            Snapshot::Runner.new.work(clean: clean)
 
-          Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] = File.expand_path(results_path) # absolute URL
+            results_path = Snapshot::SnapshotConfig.shared_instance.screenshots_path
+
+            Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] = File.expand_path(results_path) # absolute URL
+          end
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('snapshot', Snapshot::VERSION)
         end
       end
+
+      def self.description
+        "Generate new localised screenshots on multiple devices"
+      end
+
+      def self.available_options
+        [
+          ['noclean', 'Skips the clean process when building the app'],
+          ['verbose', 'Print out the UI Automation output']
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/team_id.rb

@@ -3,7 +3,7 @@ module Fastlane
     module SharedValues
     end
 
-    class TeamIdAction
+    class TeamIdAction < Action
       def self.run(params)
         team = params.first
         raise "Please pass your Team ID (e.g. team_id 'Q2CBPK58CA')".red unless team.to_s.length > 0
@@ -14,6 +14,14 @@ module Fastlane
           ENV[current.to_s] = team
         end
       end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.description
+        "Specify the Team ID you want to use for the Apple Developer Portal"
+      end
     end
   end
 end

data/lib/fastlane/actions/team_name.rb

@@ -3,7 +3,7 @@ module Fastlane
     module SharedValues
     end
 
-    class TeamNameAction
+    class TeamNameAction < Action
       def self.run(params)
         team = params.first
         raise "Please pass your Team Name (e.g. team_name 'Felix Krause')".red unless team.to_s.length > 0
@@ -14,6 +14,14 @@ module Fastlane
           ENV[current.to_s] = team
         end
       end
+
+      def self.description
+        "Set a team to use by its name"
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end