fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -21,6 +21,16 @@ module Fastlane
         "Raises an exception if there are uncommited git changes"
       end
 
+      def self.details
+        [
+          'A sanity check to make sure you are working in a repo that is clean. Especially',
+          'useful to put at the beginning of your Fastfile in the `before_all` block, if',
+          'some of your other actions will touch your filesystem, do things to your git repo,',
+          'or just as a general reminder to save your work. Also needed as a prerequisite for',
+          'some other actions like `reset_git_repo`.'
+        ].join("\n")
+      end
+
       def self.output
         [
           ['GIT_REPO_WAS_CLEAN_ON_START', 'Stores the fact that the git repo was clean at some point']
@@ -31,6 +41,14 @@ module Fastlane
         "lmirosevic"
       end
 
+      def self.example_code
+        ['ensure_git_status_clean']
+      end
+
+      def self.category
+        :source_control
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/ensure_no_debug_code.rb

@@ -47,7 +47,7 @@ module Fastlane
 
       def self.details
         [
-          "Makes sure the given text is nowhere in the code base. This can be used",
+          "You don't want any debug code to slip into production. This can be used",
           "to check if there is any debug code still in your code base or if you have",
           "things like // TO DO or similar"
         ].join("\n")
@@ -88,6 +88,26 @@ module Fastlane
         ["KrauseFx"]
       end
 
+      def self.example_code
+        [
+          'ensure_no_debug_code(text: "// TODO")',
+          'ensure_no_debug_code(text: "Log.v",
+                          extension: "java")',
+          'ensure_no_debug_code(text: "NSLog",
+                               path: "./lib",
+                          extension: "m")',
+          'ensure_no_debug_code(text: "(^#define DEBUG|NSLog)",
+                               path: "./lib",
+                          extension: "m")',
+          'ensure_no_debug_code(text: "<<<<<<",
+                         extensions: ["m", "swift", "java"])'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/ensure_xcode_version.rb

@@ -58,6 +58,14 @@ module Fastlane
         ["JaviSoto"]
       end
 
+      def self.example_code
+        ['ensure_xcode_version(version: "7.2")']
+      end
+
+      def self.category
+        :building
+      end
+
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end

data/lib/fastlane/actions/erb.rb

@@ -18,7 +18,10 @@ module Fastlane
       end
 
       def self.details
-        "Renders an ERB template with `placeholders` given as a hash via parameter, if no :destination is set, returns rendered template as string"
+        [
+          "Renders an ERB template with `placeholders` given as a hash via parameter,",
+          "if no :destination is set, returns rendered template as string"
+        ].join("\n")
       end
 
       def self.available_options
@@ -51,6 +54,32 @@ module Fastlane
         ["hjanuschka"]
       end
 
+      def self.example_code
+        [
+          '# Example `erb` template:
+
+          # Variable1 <%= var1 %>
+          # Variable2 <%= var2 %>
+          # <% for item in var3 %>
+          #        <%= item %>
+          # <% end %>
+
+          erb(
+            template: "1.erb",
+            destination: "/tmp/rendered.out",
+            placeholders: {
+              :var1 => 123,
+              :var2 => "string",
+              :var3 => ["element1", "element2"]
+            }
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/fastlane_version.rb

@@ -5,7 +5,7 @@ module Fastlane
 
     class FastlaneVersionAction < Action
       def self.run(params)
-        params = nil unless params.kind_of? Array
+        params = nil unless params.kind_of?(Array)
         value = (params || []).first
         defined_version = Gem::Version.new(value) if value
 
@@ -15,7 +15,7 @@ module Fastlane
           UI.user_error!("The Fastfile requires a fastlane version of >= #{defined_version}. You are on #{Fastlane::VERSION}. Please update using `sudo gem update fastlane`.")
         end
 
-        UI.message("fastlane version valid")
+        UI.message("Your fastlane version #{Fastlane::VERSION} matches the minimum requirement of #{defined_version}  ✅")
       end
 
       def self.step_text
@@ -30,6 +30,21 @@ module Fastlane
         "Verifies the minimum fastlane version required"
       end
 
+      def self.example_code
+        ['fastlane_version "1.50.0"']
+      end
+
+      def self.details
+        [
+          "Add this to your `Fastfile` to require a certain version of _fastlane_.",
+          "Use it if you use an action that just recently came out and you need it"
+        ].join("\n")
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/flock.rb

@@ -33,6 +33,13 @@ module Fastlane
         "Send a message to a Flock group"
       end
 
+      def self.details
+        [
+          "To obtain the token, create a new [incoming message webhook](https://dev.flock.co/wiki/display/FlockAPI/Incoming+Webhooks)",
+          "in your Flock admin panel."
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :message,
@@ -56,6 +63,19 @@ module Fastlane
         "Manav"
       end
 
+      def self.example_code
+        [
+          'flock(
+            message: "Hello",
+            token: "xxx"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/frameit.rb

@@ -24,6 +24,13 @@ module Fastlane
         "Adds device frames around the screenshots using frameit"
       end
 
+      def self.details
+        [
+          "Use [frameit](https://github.com/fastlane/fastlane/tree/master/frameit) to prepare perfect screenshots for the App Store, your website, QA",
+          "or emails. You can add background and titles to the framed screenshots as well."
+        ].join("\n")
+      end
+
       def self.available_options
         require "frameit"
         require "frameit/options"
@@ -39,6 +46,17 @@ module Fastlane
         "KrauseFx"
       end
 
+      def self.example_code
+        [
+          'frameit',
+          'frameit :silver'
+        ]
+      end
+
+      def self.category
+        :screenshots
+      end
+
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end

data/lib/fastlane/actions/gcovr.rb

@@ -140,6 +140,24 @@ module Fastlane
       def self.author
         "dtrenz"
       end
+
+      def self.example_code
+        [
+          'gcovr(
+            html: true,
+            html_details: true,
+            output: "./code-coverage/report.html"
+          )'
+        ]
+      end
+
+      def self.details
+        "Generate summarized code coverage reports using [gcovr](http://gcovr.com/)"
+      end
+
+      def self.category
+        :testing
+      end
     end
   end
 end

data/lib/fastlane/actions/get_build_number.rb

@@ -78,6 +78,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'build_number = get_build_number(xcodeproj: "Project.xcodeproj")'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/get_build_number_repository.rb

@@ -69,6 +69,14 @@ module Fastlane
         "Get the build number from the current repository"
       end
 
+      def self.details
+        [
+          "This action will get the **build number** according to what the SCM HEAD reports.",
+          "Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision) and git (uses short hash) and mercurial (uses short hash or revision number).",
+          "There is an option, `:use_hg_revision_number`, which allows to use mercurial revision number instead of hash."
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :use_hg_revision_number,
@@ -97,6 +105,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'get_build_number_repository'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/get_github_release.rb

@@ -92,7 +92,7 @@ module Fastlane
                  "tarball_url"=>"https://api.github.com/repos/KrauseFx/fastlane/tarball/1.8.0",
                  "zipball_url"=>"https://api.github.com/repos/KrauseFx/fastlane/zipball/1.8.0",
                  "body"=> ...Markdown...
-                "This is one of the biggest updates of `fastlane` yet"
+                "This is one of the biggest updates of _fastlane_ yet"
               }'
 
         [
@@ -141,6 +141,23 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'release = get_github_release(url: "fastlane/fastlane", version: "1.0.0")
+          puts release["name"]'
+        ]
+      end
+
+      def self.sample_return_value
+        {
+          "name" => "name"
+        }
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/get_info_plist_value.rb

@@ -26,6 +26,10 @@ module Fastlane
         "Returns value from Info.plist of your project as native Ruby data structures"
       end
 
+      def self.details
+        "Get a value from a plist file, which can be used to fetch the app identifier and more information about your app"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :key,
@@ -55,6 +59,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'identifier = get_info_plist_value(path: "./Info.plist", key: "CFBundleIdentifier")'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/get_ipa_info_plist_value.rb

@@ -62,6 +62,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'get_ipa_info_plist_value(ipa: "path.ipa", key: "KEY_YOU_READ")'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/get_version_number.rb

@@ -141,6 +141,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'version = get_version_number(xcodeproj: "Project.xcodeproj")'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/git_add.rb

@@ -21,10 +21,6 @@ module Fastlane
         "Directly add the given file"
       end
 
-      def self.details
-        ""
-      end
-
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :path,
@@ -42,9 +38,6 @@ module Fastlane
         ]
       end
 
-      def self.output
-      end
-
       def self.return_value
         nil
       end
@@ -56,6 +49,17 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'git_add(path: "./version.txt")',
+          'git_add(path: ["./version.txt", "./changelog.txt"])'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end