fastlane 1.104.0 → 1.105.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b26b52939a17cf65ea9c22d2a7d8b43592f89d9
-  data.tar.gz: 38a7c3fc0fc60eabd03a26715457fbc0e5373048
+  metadata.gz: f9312f91a742670a12fe827ceb8b6876bc0ebc58
+  data.tar.gz: deffb3c8f089730cc917fec54dea826ee70ffa64
 SHA512:
-  metadata.gz: bd33eb7f6d926a656b17615772b1e38dcd07b8a4851fabc230113e356b1a1c44dca7c11bf6c36e836a7b08ee833ae6c613f78123e9ea1cb441944bc4d1c76709
-  data.tar.gz: 8c420e4c6279c9cae2f92d08e1784b53497ac847e358521db1caac9b332f46fed8db1ede711f323681d6d685ed905b4f52b99fc2930125c129e24f1da6a42749
+  metadata.gz: 2e6ae9904194cc2349e56f46e8152e0531f8b6c41dbd90b8f1c7e9793d005122e2fd2b44260794263e9ff82568b7d46d1884718d050a3666546979fe95151ddc
+  data.tar.gz: 22db4c5c609a3222de2509bc95113343ddc80f5b1ae7afc5c345e85e651e4de58366b62bdd1bb65786e1e475be9741716f17328a0ae7ed9ce3382225cf721941

data/lib/assets/Actions.md.erb

@@ -0,0 +1,78 @@
+# fastlane actions
+
+This page contains a list of all built-in fastlane actions and their available options.
+
+To get the most up-to-date information from the command line on your current version you can also run
+
+```sh
+fastlane actions # list all available fastlane actions
+fastlane action [action_name] # more information for a specific action
+```
+
+You can import another `Fastfile` by using the `import` action. This is useful if you have shared lanes across multiple apps and you want to store a `Fastfile` in a separate folder. The path must be relative to the `Fastfile` this is called from.
+
+```ruby
+import './path/to/other/Fastfile'
+```
+
+<%- @categories.each do |category, actions| -%>
+- [<%= category %>](#<%= category.gsub(" ", "-").downcase %>)
+<%- end -%>
+- [Plugins](#Plugins)
+
+
+
+<%- @categories.each do |category, actions| %>
+# <%= category %>
+  <%- actions.sort.reverse.to_h.each do |_number_of_launches, action| -%>
+
+### <%= action.action_name %>
+
+<%= action.description %>
+
+<%= "> #{action.details.gsub("\n\n", "\n")}" unless action.details.to_s.empty? %>
+
+<%= action.action_name %> | 
+-----|----
+Supported platforms | <%= [:ios, :android, :mac].find_all { |a| action.is_supported?(a) }.join(", ") %>
+Author | @<%= Array(action.author || action.authors).join(", @") %>
+<%- unless action.return_value.to_s.empty? -%>
+Returns | <%= action.return_value %>
+<%- end -%>
+
+<% if (action.example_code || []).count > 0 %>
+
+<details>
+<summary><%= action.example_code.count %> Example<%= (action.example_code.count > 1) ? "s" : "" %></summary>
+<% action.example_code.each do |current_sample| %>
+```ruby
+<%= current_sample.gsub("          ", "") %>
+```
+<% end %>
+<% end %>
+</details>
+
+<% if action.available_options && action.available_options.first.kind_of?(FastlaneCore::ConfigItem) %>
+<details>
+<summary>Parameters</summary>
+
+Key | Description
+----|------------
+<%- (action.available_options || []).each do |config_item| -%>
+  <%- next unless config_item.kind_of?(FastlaneCore::ConfigItem) -%>
+  `<%= config_item.key %>` | <%= config_item.description %>
+<%- end %>
+</details>
+<% end %>
+
+
+
+  <%- end %>
+<%- end %>
+
+# Plugins
+| Action | Plugin | Description | Usage Number
+---------|--------|-------------|--------------
+<%- @plugins.each do |plugin| -%>
+<%= plugin[:action_name] %> | <%= plugin[:linked_title] %> | <%= plugin[:description] %> | <%= plugin[:usage] %>
+<%- end -%>

data/lib/assets/AvailablePlugins.md.erb

@@ -2,13 +2,13 @@
 
 To get an up to date list of all available plugins run
 
-```
+```no-highlight
 fastlane search_plugins
 ```
 
 To search for a specific plugin
 
-```
+```no-highlight
 fastlane search_plugins [search_query]
 ```
 

data/lib/fastlane/action.rb

@@ -2,6 +2,22 @@ require 'fastlane/actions/actions_helper'
 
 module Fastlane
   class Action
+    AVAILABLE_CATEGORIES = [
+      :testing,
+      :building,
+      :screenshots,
+      :project,
+      :code_signing,
+      :documentation,
+      :beta,
+      :push,
+      :production,
+      :source_control,
+      :notifications,
+      :deprecated,
+      :misc
+    ]
+
     class << self
       attr_accessor :runner
     end
@@ -40,6 +56,13 @@ module Fastlane
       nil
     end
 
+    def self.sample_return_value
+      # Very optional
+      # You can return a sample return value, that might be returned by the actual action
+      # This is currently only used when generating the documentation and running its tests
+      nil
+    end
+
     def self.author
       nil
     end
@@ -59,6 +82,11 @@ module Fastlane
       UI.crash!("Implementing `is_supported?` for all actions is mandatory. Please update #{self}")
     end
 
+    # Returns an array of string of sample usage of this action
+    def self.example_code
+      nil
+    end
+
     # Is printed out in the Steps: output in the terminal
     # Return nil if you don't want any logging in the terminal/JUnit Report
     def self.step_text
@@ -70,6 +98,11 @@ module Fastlane
       Fastlane::Actions.sh_control_output(command, print_command: print_command, print_command_output: print_command_output, error_callback: error_callback)
     end
 
+    # Documentation category, availabe values defined in AVAILABLE_CATEGORIES
+    def self.category
+      :undefined
+    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

data/lib/fastlane/actions/adb.rb

@@ -48,6 +48,18 @@ module Fastlane
       def self.output
       end
 
+      def self.category
+        :building
+      end
+
+      def self.example_code
+        [
+          'adb(
+            command: "shell ls"
+          )'
+        ]
+      end
+
       def self.return_value
         "The output of the adb command"
       end

data/lib/fastlane/actions/adb_devices.rb

@@ -20,7 +20,7 @@ module Fastlane
 
       def self.details
         [
-          "fetches device list via adb"
+          "Fetches device list via adb, e.g. run an adb command on all connected devices."
         ].join("\n")
       end
 
@@ -38,8 +38,27 @@ module Fastlane
       def self.output
       end
 
+      def self.example_code
+        [
+          'adb_devices.each do |device|
+            model = adb(command: "shell getprop ro.product.model",
+                        serial: device.serial).strip
+
+            puts "Model #{model} is connected"
+          end'
+        ]
+      end
+
+      def self.sample_return_value
+        []
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.return_value
-        "Array of devices"
+        "Returns an array of all currently connected android devices"
       end
 
       def self.authors

data/lib/fastlane/actions/add_git_tag.rb

@@ -23,6 +23,18 @@ module Fastlane
         "This will add an annotated git tag to the current branch"
       end
 
+      def self.details
+        [
+          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number>`, where:",
+          "- `grouping` is just to keep your tags organised under one 'folder', defaults to 'builds'",
+          "- `lane` is the name of the current fastlane lane",
+          "- `prefix` is anything you want to stick in front of the version number, e.g. 'v'",
+          "- `build_number` is the build number, which defaults to the value emitted by the `increment_build_number` action",
+          "",
+          "For example for build 1234 in the 'appstore' lane it will tag the commit with `builds/appstore/1234`"
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :tag,
@@ -59,6 +71,25 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'add_git_tag # simple tag with default values',
+          'add_git_tag(
+            grouping: "fastlane-builds",
+            prefix: "v",
+            build_number: 123
+          )',
+          '# Alternatively, you can specify your own tag. Note that if you do specify a tag, all other arguments are ignored.
+          add_git_tag(
+            tag: "my_custom_tag"
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+
       def self.authors
         ["lmirosevic", "maschall"]
       end

data/lib/fastlane/actions/appaloosa.rb

@@ -226,6 +226,33 @@ module Fastlane
         url_for_download_response.kind_of?(Net::HTTPNotFound) ||
           url_for_download_response.kind_of?(Net::HTTPForbidden)
       end
+
+      def self.example_code
+        [
+          "appaloosa(
+            # Path tor your IPA or APK
+            binary: '/path/to/binary.ipa',
+            # You can find your store’s id at the bottom of the “Settings” page of your store
+            store_id: 'your_store_id',
+            # You can find your api_token at the bottom of the “Settings” page of your store
+            api_token: 'your_api_key',
+            # User group_ids visibility, if it's not specified we'll publish the app for all users in your store'
+            group_ids: '112, 232, 387',
+            # You can use fastlane/snapshot or specify your own screenshots folder.
+            # If you use snapshot please specify a local and a device to upload your screenshots from.
+            # When multiple values are specified in the Snapfile, we default to 'en-US'
+            locale: 'en-US',
+            # By default, the screenshots from the last device will be used
+            device: 'iPhone6',
+            # Screenshots' filenames should start with device's name like 'iphone6-s1.png' if device specified
+            screenshots: '/path/to_your/screenshots'
+          )"
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/appetize.rb

@@ -87,7 +87,15 @@ module Fastlane
       private_class_method :parse_response
 
       def self.description
-        "Create or Update apps on Appetize.io"
+        "Upload your app to Appetize.io to stream it in the browser"
+      end
+
+      def self.details
+        [
+          "If you provide a `public_key`, this will overwrite an existing application. If you want to have this build as a new app version, you shouldn't provide this value.",
+          "",
+          "To integrate appetize into your GitHub workflow check out the [device_grid guide](https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/device_grid/README.md)"
+        ].join("\n")
       end
 
       def self.available_options
@@ -143,6 +151,20 @@ module Fastlane
       def self.authors
         ["klundberg", "giginet"]
       end
+
+      def self.category
+        :beta
+      end
+
+      def self.example_code
+        [
+          'appetize(
+            path: "./MyApp.zip",
+            api_token: "yourapitoken", # get it from https://appetize.io/docs#request-api-token
+            public_key: "your_public_key" # get it from https://appetize.io/dashboard
+          )'
+        ]
+      end
     end
   end
 end

data/lib/fastlane/actions/appetize_viewing_url_generator.rb

@@ -39,6 +39,7 @@ module Fastlane
       end
 
       def self.details
+        "Check out the [device_grid guide](https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/device_grid/README.md) for more information"
       end
 
       def self.available_options
@@ -99,7 +100,8 @@ module Fastlane
         ]
       end
 
-      def self.output
+      def self.category
+        :misc
       end
 
       def self.return_value

data/lib/fastlane/actions/appium.rb

@@ -170,6 +170,24 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.category
+        :testing
+      end
+
+      def self.example_code
+        [
+          'appium(
+            app_path:  "appium/apps/TargetApp.app",
+            spec_path: "appium/spec",
+            platform:  "iOS",
+            caps: {
+              versionNumber: "9.1",
+              deviceName:    "iPhone 6"
+            }
+          )'
+        ]
+      end
     end
   end
 end

data/lib/fastlane/actions/appledoc.rb

@@ -113,6 +113,10 @@ module Fastlane
       end
 
       def self.description
+        "Generate Apple-like source code documentation from the source code"
+      end
+
+      def self.details
         "Runs `appledoc [OPTIONS] <paths to source dirs or files>` for the project"
       end
 
@@ -191,6 +195,26 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.category
+        :documentation
+      end
+
+      def self.example_code
+        [
+          'appledoc(
+            project_name: "MyProjectName",
+            project_company: "Company Name",
+            input: "MyProjectSources",
+            ignore: [
+              "ignore/path/1",
+              "ingore/path/2"
+            ],
+            options: "--keep-intermediate-files --search-undocumented-doc",
+            warnings: "--warn-missing-output-path --warn-missing-company-id"
+          )'
+        ]
+      end
     end
   end
 end

data/lib/fastlane/actions/appstore.rb

@@ -30,6 +30,14 @@ module Fastlane
       def self.is_supported?(platform)
         Actions::DeliverAction.is_supported?(platform)
       end
+
+      def self.category
+        Actions::DeliverAction.category
+      end
+
+      def self.example_code
+        Actions::DeliverAction.example_code
+      end
     end
   end
 end