fastlane 0.6.1 → 0.7.0

data/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -5,7 +5,7 @@ module Fastlane
     end
 
     # Raises an exception and stop the lane execution if the repo is not in a clean state
-    class EnsureGitStatusCleanAction
+    class EnsureGitStatusCleanAction < Action
       def self.run(_params)
         repo_clean = `git status --porcelain`.empty?
 
@@ -16,6 +16,20 @@ module Fastlane
           raise 'Git repository is dirty! Please ensure the repo is in a clean state by commiting/stashing/discarding all changes first.'.red
         end
       end
+
+      def self.description
+        "Raises an exception if there are uncommited git changes"
+      end
+
+      def self.output
+        [
+          ['GIT_REPO_WAS_CLEAN_ON_START', 'Stores the fact that the git repo was clean at some point']
+        ]
+      end
+
+      def self.author
+        "lmirosevic"
+      end
     end
   end
 end

data/lib/fastlane/actions/fastlane_version.rb

@@ -4,7 +4,7 @@ module Fastlane
       
     end
 
-    class FastlaneVersionAction
+    class FastlaneVersionAction < Action
       def self.run(params)
         defined_version = ((Gem::Version.new(params.first) if params.first) rescue nil)
         raise "Please pass minimum fastlane version as parameter to fastlane_version".red unless defined_version
@@ -19,6 +19,14 @@ module Fastlane
       def self.step_text
         "Verifying required fastlane version"
       end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.description
+        "Verifies the minimum fastlane version required"
+      end
     end
   end
 end

data/lib/fastlane/actions/frameit.rb

@@ -1,24 +1,34 @@
 module Fastlane
   module Actions
-    module SharedValues
-    end
-
-    class FrameitAction
+    class FrameitAction < Action
       def self.run(params)
         return if Helper.test?
 
         require 'frameit'
 
-        color = Frameit::Editor::Color::BLACK
-        color = Frameit::Editor::Color::SILVER if [:silver, :white].include?(params.first)
+        begin
+          FastlaneCore::UpdateChecker.start_looking_for_update('frameit')
+          color = Frameit::Editor::Color::BLACK
+          color = Frameit::Editor::Color::SILVER if [:silver, :white].include?(params.first)
 
-        screenshots_folder = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
-        screenshots_folder ||= FastlaneFolder.path
+          screenshots_folder = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
+          screenshots_folder ||= FastlaneFolder.path
 
-        Dir.chdir(screenshots_folder) do
-          Frameit::Editor.new.run('.', color)
+          Dir.chdir(screenshots_folder) do
+            Frameit::Editor.new.run('.', color)
+          end
+        ensure
+          FastlaneCore::UpdateChecker.show_update_status('frameit', Frameit::VERSION)
         end
       end
+
+      def self.description
+        "Adds device frames around the screenshots using frameit"
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/gcovr.rb

@@ -22,7 +22,7 @@ module Fastlane
     # -g, --use-gcov-files           Use preprocessed gcov files for analysis.
     # -s, --print-summary            Prints a small report to stdout with line & branch percentage coverage
 
-    class GcovrAction
+    class GcovrAction < Action
       ARGS_MAP = {
         object_directory: "--object-directory",
         output: "-o",
@@ -101,6 +101,40 @@ module Fastlane
           end
         end.compact
       end
+
+      def self.description
+        "Runs test coverage reports for your Xcode project"
+      end
+
+      def self.available_options
+        [
+          ['object_directory', 'Specify the directory that contains the gcov data files.'],
+          ['output', 'Print output to this filename Keep the temporary *.gcov files generated by gcov.'],
+          ['keep', 'Keep the temporary *.gcov files generated by gcov.'],
+          ['delete', 'Delete the coverage files after they are processed.'],
+          ['filter', 'Keep only the data files that match this regular expression'],
+          ['exclude', 'Exclude data files that match this regular expression'],
+          ['gcov_filter', 'Keep only gcov data files that match this regular expression'],
+          ['gcov_exclude', 'Exclude gcov data files that match this regular expression'],
+          ['root', 'Defines the root directory for source files.'],
+          ['xml', 'Generate XML instead of the normal tabular output.'],
+          ['xml_pretty', 'Generate pretty XML instead of the normal dense format.'],
+          ['html', 'Generate HTML instead of the normal tabular output.'],
+          ['html_details', 'Generate HTML output for source file coverage.'],
+          ['html_absolute_paths', 'Set the paths in the HTML report to be absolute instead of relative'],
+          ['branches', 'Tabulate the branch coverage instead of the line coverage.'],
+          ['sort_uncovered', 'Sort entries by increasing number of uncovered lines.'],
+          ['sort_percentage', 'Sort entries by decreasing percentage of covered lines.'],
+          ['gcov_executable', 'Defines the name/path to the gcov executable].'],
+          ['exclude_unreachable_branches', 'Exclude from coverage branches which are marked to be excluded by LCOV/GCOV markers'],
+          ['use_gcov_files', 'Use preprocessed gcov files for analysis.'],
+          ['print_summary', 'Prints a small report to stdout with line & branch percentage coverage']
+        ]
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
   end
 end

data/lib/fastlane/actions/hipchat.rb

@@ -3,7 +3,7 @@ module Fastlane
     module SharedValues
     end
 
-    class HipchatAction
+    class HipchatAction < Action
       def self.run(params)
         options = { message: '',
                     success: true,
@@ -87,6 +87,24 @@ module Fastlane
             raise "Unexpected #{response.code} for `#{channel}'".red
         end
       end
+
+      def self.description
+        "Send a error/success message to HipChat"
+      end
+
+      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?'],
+        ]
+      end
+
+      def self.author
+        "jingx23"
+      end
     end
   end
 end

data/lib/fastlane/actions/hockey.rb

@@ -9,7 +9,7 @@ module Fastlane
       HOCKEY_BUILD_INFORMATION = :HOCKEY_BUILD_INFORMATION # contains all keys/values from the HockeyApp API, like :title, :bundle_identifier
     end
 
-    class HockeyAction
+    class HockeyAction < Action
       def self.run(params)
         # Available options: http://support.hockeyapp.net/kb/api/api-versions#upload-version
         options = {
@@ -63,6 +63,32 @@ module Fastlane
             raise 'Error when trying to upload ipa to HockeyApp'.red
           end
       end
+
+      def self.description
+        "Upload a new build to HockeyApp"
+      end
+
+      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', 'No description'],
+          ['notify', 'Notify testers? 1 for yes'],
+        ]
+      end
+
+      def output
+        [
+          ['HOCKEY_DOWNLOAD_LINK', 'The newly generated download link for this build'],
+          ['HOCKEY_BUILD_INFORMATION', 'contains all keys/values from the HockeyApp API, like :title, :bundle_identifier']
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/increment_build_number.rb

@@ -4,7 +4,7 @@ module Fastlane
       BUILD_NUMBER = :BUILD_NUMBER
     end
 
-    class IncrementBuildNumberAction
+    class IncrementBuildNumberAction < Action
       require 'shellwords'
 
       def self.run(params)
@@ -55,6 +55,27 @@ module Fastlane
           raise ex
         end
       end
+
+      def self.description
+        "Increment the build number of your project"
+      end
+
+      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']
+        ]
+      end
+
+      def self.output
+        [
+          ['BUILD_NUMBER', 'The new build number']
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/increment_version_number.rb

@@ -4,7 +4,7 @@ module Fastlane
       VERSION_NUMBER = :VERSION_NUMBER
     end
 
-    class IncrementVersionNumberAction
+    class IncrementVersionNumberAction < Action
       require 'shellwords'
 
       def self.run(params)
@@ -93,6 +93,35 @@ module Fastlane
           raise ex
         end
       end
+
+      def self.description
+        "Increment the build number of your project"
+      end
+
+      def self.details
+        [
+          "This action will increment the version number. ", 
+          "You first have to set up your Xcode project, if you haven't done it already:",
+          "https://developer.apple.com/library/ios/qa/qa1827/_index.html"
+        ].join(' ')
+      end
+
+      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']
+        ]
+      end
+
+      def self.output
+        [
+          ['VERSION_NUMBER', 'The new version number']
+        ]
+      end
+
+      def self.author
+        "serluca"
+      end
     end
   end
 end

data/lib/fastlane/actions/install_carthage.rb

@@ -1,9 +1,17 @@
 module Fastlane
   module Actions
-    class CarthageAction
+    class CarthageAction < Action
       def self.run(_params)
         Actions.sh('carthage bootstrap')
       end
+
+      def self.description
+        "Runs `carthage bootstrap` for your project"
+      end
+
+      def self.author
+        "bassrock"
+      end
     end
   end
 end

data/lib/fastlane/actions/install_cocapods.rb

@@ -1,9 +1,13 @@
 module Fastlane
   module Actions
-    class CocoapodsAction
+    class CocoapodsAction < Action
       def self.run(_params)
         Actions.sh('pod install')
       end
+
+      def self.description
+        "Runs `pod install` for the project"
+      end
     end
   end
 end

data/lib/fastlane/actions/ipa.rb

@@ -5,19 +5,19 @@ 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)
+    # -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)
+    # -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',
@@ -35,7 +35,7 @@ module Fastlane
       xcargs: '--xcargs',
     }
 
-    class IpaAction
+    class IpaAction < Action
       def self.run(params)
         # The args we will build with
         build_args = nil
@@ -122,6 +122,45 @@ module Fastlane
         # Finds last modified .dSYM.zip in the destination directory
         Dir[File.join(dir, '*.dSYM.zip')].sort { |a, b| File.mtime(b) <=> File.mtime(a) }.first
       end
+
+      def self.description
+        "Easily build and sign your app using shenzhen"
+      end
+
+      def self.details
+        [
+          "More information on the shenzhen project page: https://github.com/nomad/shenzhen"
+        ].join(' ')
+      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'],
+          ['verbose', 'use SDK as the name or path of the base SDK when building the project'],
+          ['xcargs', 'specify the name of the .ipa file to generate (including file extension)']
+        ]
+      end
+
+      def self.output
+        [
+          ['IPA_OUTPUT_PATH', 'The path to the newly generated ipa file'],
+          ['DSYM_OUTPUT_PATH', 'The path to the dsym file']
+        ]
+      end
+
+      def self.author
+        "joshdholtz"
+      end
     end
   end
 end

data/lib/fastlane/actions/notify.rb

@@ -1,12 +1,20 @@
 module Fastlane
   module Actions
-    class NotifyAction
+    class NotifyAction < Action
       def self.run(params)
         require 'terminal-notifier'
 
         text = params.join(' ')
         TerminalNotifier.notify(text, title: 'fastlane')
       end
+
+      def self.description
+        "Shows a Mac OS X notification"
+      end
+
+      def author
+        "champo"
+      end
     end
   end
 end