fastlane 2.94.0.beta.20180425050017 → 2.94.0.beta.20180426050049

data/fastlane/lib/fastlane/actions/modify_services.rb

@@ -78,8 +78,7 @@ module Fastlane
 
       def self.details
         [
-          "Options are same as 'enable_services' in produce action",
-          "https://docs.fastlane.tools/actions/produce/"
+          "The options are the same as `:enable_services` in the [produce action](https://docs.fastlane.tools/actions/produce/#parameters_1)"
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/notify.rb

@@ -33,7 +33,7 @@ module Fastlane
       end
 
       def self.deprecated_notes
-        "It's recommended to use the new 'notification' method instead of 'notify'"
+        "It's recommended to use the new `notification` action instead of `notify`"
       end
     end
   end

data/fastlane/lib/fastlane/actions/number_of_commits.rb

@@ -48,7 +48,7 @@ module Fastlane
       end
 
       def self.details
-        "You can use this action to get the number of commits of this branch. This is useful if you want to set the build number to the number of commits. See `fastlane actions number_of_commits` for more details"
+        "You can use this action to get the number of commits of this branch. This is useful if you want to set the build number to the number of commits. See `fastlane actions number_of_commits` for more details."
       end
 
       def self.authors

data/fastlane/lib/fastlane/actions/oclint.rb

@@ -224,7 +224,7 @@ module Fastlane
       end
 
       def self.details
-        "Run the static analyzer tool [OCLint](http://oclint.org) for your project. You need to have a `compile_commands.json` file in your _fastlane_ directory or pass a path to your file"
+        "Run the static analyzer tool [OCLint](http://oclint.org) for your project. You need to have a `compile_commands.json` file in your _fastlane_ directory or pass a path to your file."
       end
 
       def self.example_code

data/fastlane/lib/fastlane/actions/onesignal.rb

@@ -62,7 +62,7 @@ module Fastlane
       end
 
       def self.details
-        "You can use this action to automatically create a OneSignal application. You can also upload a .p12 with password, a GCM key, or both"
+        "You can use this action to automatically create a OneSignal application. You can also upload a `.p12` with password, a GCM key, or both."
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/opt_out_crash_reporting.rb

@@ -10,9 +10,7 @@ module Fastlane
       end
 
       def self.details
-        [
-          "fastlane doesn't have crash reporting any more, feel free to remove `opt_out_crash_reporting` from your Fastfile"
-        ].join(' ')
+        "_fastlane_ doesn't have crash reporting any more. Feel free to remove `opt_out_crash_reporting` from your Fastfile."
       end
 
       def self.authors

data/fastlane/lib/fastlane/actions/opt_out_usage.rb

@@ -12,11 +12,10 @@ module Fastlane
 
       def self.details
         [
-          "By default, fastlane will track what actions are being used",
-          "No personal/sensitive information is recorded.",
-          "Learn more at https://docs.fastlane.tools/#metrics",
-          "Add `opt_out_usage` at the top of your Fastfile to disable metrics collection"
-        ].join(' ')
+          "By default, _fastlane_ will track what actions are being used. No personal/sensitive information is recorded.",
+          "Learn more at [https://docs.fastlane.tools/#metrics](https://docs.fastlane.tools/#metrics).",
+          "Add `opt_out_usage` at the top of your Fastfile to disable metrics collection."
+        ].join("\n")
       end
 
       def self.author

data/fastlane/lib/fastlane/actions/pod_push.rb

@@ -52,10 +52,6 @@ module Fastlane
         "Push a Podspec to Trunk or a private repository"
       end
 
-      def self.details
-        ""
-      end
-
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :use_bundle_exec,

data/fastlane/lib/fastlane/actions/podio_item.rb

@@ -25,11 +25,11 @@ module Fastlane
       end
 
       def self.details
-        "Use this action to create or update an item within your Podio app
-        (see https://help.podio.com/hc/en-us/articles/201019278-Creating-apps-).
-        Pass in dictionary with field keys and their values.
-        Field key is located under Modify app -> Advanced -> Developer -> External ID
-        (see https://developers.podio.com/examples/items)"
+        [
+          "Use this action to create or update an item within your Podio app (see [https://help.podio.com/hc/en-us/articles/201019278-Creating-apps-](https://help.podio.com/hc/en-us/articles/201019278-Creating-apps-)).",
+          "Pass in dictionary with field keys and their values.",
+          "Field key is located under `Modify app` -> `Advanced` -> `Developer` -> `External ID` (see [https://developers.podio.com/examples/items](https://developers.podio.com/examples/items))."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/prompt.rb

@@ -34,8 +34,8 @@ module Fastlane
 
       def self.details
         [
-          "You can use `prompt` to ask the user for a value or to just let the user confirm the next step",
-          "When this is executed on a CI service, the passed `ci_input` value will be returned",
+          "You can use `prompt` to ask the user for a value or to just let the user confirm the next step.",
+          "When this is executed on a CI service, the passed `ci_input` value will be returned.",
           "This action also supports multi-line inputs using the `multi_line_end_keyword` option."
         ].join("\n")
       end

data/fastlane/lib/fastlane/actions/push_to_git_remote.rb

@@ -69,11 +69,7 @@ module Fastlane
       end
 
       def self.details
-        [
-          "Lets you push your local commits to a remote git repo. Useful if you make local changes such as adding a version bump commit",
-          "(using `commit_version_bump`) or a git tag (using 'add_git_tag') on a CI server, and you want to push those changes back to your",
-          "canonical/main repo."
-        ].join(" ")
+        "Lets you push your local commits to a remote git repo. Useful if you make local changes such as adding a version bump commit (using `commit_version_bump`) or a git tag (using 'add_git_tag') on a CI server, and you want to push those changes back to your canonical/main repo."
       end
 
       def self.is_supported?(platform)

data/fastlane/lib/fastlane/actions/read_podspec.rb

@@ -29,12 +29,10 @@ module Fastlane
 
       def self.details
         [
-          "This can be used for only specifying a version string in your podspec",
-          "- and during your release process you'd read it from the podspec by running",
-          "`version = read_podspec['version']` at the beginning of your lane",
+          "This can be used for only specifying a version string in your podspec - and during your release process you'd read it from the podspec by running `version = read_podspec['version']` at the beginning of your lane.",
           "Loads the specified (or the first found) podspec in the folder as JSON, so that you can inspect its `version`, `files` etc.",
-          "This can be useful when basing your release process on the version string only stored in one place - in the podspec. As one of ",
-          "the first steps you'd read the podspec and its version and the rest of the workflow can use that version string (when e.g. creating a new git tag or a GitHub Release)."
+          "This can be useful when basing your release process on the version string only stored in one place - in the podspec.",
+          "As one of the first steps you'd read the podspec and its version and the rest of the workflow can use that version string (when e.g. creating a new git tag or a GitHub Release)."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/register_device.rb

@@ -73,7 +73,7 @@ module Fastlane
         [
           "This will register an iOS device with the Developer Portal so that you can include it in your provisioning profiles.",
           "This is an optimistic action, in that it will only ever add a device to the member center. If the device has already been registered within the member center, it will be left alone in the member center.",
-          "The action will connect to the Apple Developer Portal using the username you specified in your `Appfile` with `apple_id`, but you can override it using the `username` option."
+          "The action will connect to the Apple Developer Portal using the username you specified in your `Appfile` with `apple_id`, but you can override it using the `:username` option."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/reset_git_repo.rb

@@ -45,12 +45,16 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list
+          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.
+        LIST
+
         [
-          "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.",
+          "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 running _fastlane_.",
           "Untracked files like `.env` will also be deleted, unless `:skip_clean` is true.",
-          "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(' ')
+          "It's a pretty drastic action so it comes with a sort of safety latch. It will only proceed with the reset if this condition is met:".markdown_preserve_newlines,
+          list
+        ].join("\n")
       end
 
       def self.example_code

data/fastlane/lib/fastlane/actions/resign.rb

@@ -18,16 +18,18 @@ module Fastlane
       end
 
       def self.details
+        sample = <<-SAMPLE.markdown_sample
+          ```ruby
+          resign(ipa: "path", signing_identity: "identity", provisioning_profile: {
+            "com.example.awesome-app" => "App.mobileprovision",
+            "com.example.awesome-app.app-extension" => "Extension.mobileprovision"
+          })
+          ```
+        SAMPLE
+
         [
-          "You may provide multiple provisioning profiles if the application contains",
-          "nested applications or app extensions, which need their own provisioning",
-          "profile. You can do so by passing an array of provisiong profile strings or a",
-          "hash that associates provisioning profile values to bundle identifier keys.",
-          "",
-          "resign(ipa: \"path\", signing_identity: \"identity\", provisioning_profile: {",
-          "  \"com.example.awesome-app\" => \"App.mobileprovision\",",
-          "  \"com.example.awesome-app.app-extension\" => \"Extension.mobileprovision\"",
-          "})"
+          "You may provide multiple provisioning profiles if the application contains nested applications or app extensions, which need their own provisioning profile. You can do so by passing an array of provisiong profile strings or a hash that associates provisioning profile values to bundle identifier keys.".markdown_preserve_newlines,
+          sample
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/rsync.rb

@@ -22,7 +22,7 @@ module Fastlane
       end
 
       def self.details
-        "A wrapper around rsync, rsync is a tool that lets you synchronize files, including permissions and so on for a more detailed information about rsync please see rsync(1) manpage."
+        "A wrapper around `rsync`, which is a tool that lets you synchronize files, including permissions and so on. For a more detailed information about `rsync`, please see [rsync(1) man page](https://linux.die.net/man/1/rsync)."
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/s3.rb

@@ -316,7 +316,7 @@ module Fastlane
           "Upload a new build to Amazon S3 to distribute the build to beta testers.",
           "Works for both Ad Hoc and Enterprise signed applications. This step will generate the necessary HTML, plist, and version files for you.",
           "It is recommended to **not** store the AWS access keys in the `Fastfile`. The uploaded `version.json` file provides an easy way for apps to poll if a new update is available."
-        ].join(" ")
+        ].join("\n")
       end
 
       def self.available_options
@@ -449,8 +449,10 @@ module Fastlane
       end
 
       def self.deprecated_notes
-        "Please use the `aws_s3` plugin instead.\n" \
+        [
+          "Please use the `aws_s3` plugin instead.",
           "Install using `fastlane add_plugin aws_s3`."
+        ].join("\n")
       end
     end
     # rubocop:enable Metrics/ClassLength

data/fastlane/lib/fastlane/actions/set_build_number_repository.rb

@@ -31,7 +31,7 @@ module Fastlane
         [
           "This action will set 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"
+          "There is an option, `:use_hg_revision_number`, which allows to use mercurial revision number instead of hash."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/set_changelog.rb

@@ -85,7 +85,7 @@ module Fastlane
         [
           "This is useful if you have only one changelog for all languages.",
           "You can store the changelog in `#{default_changelog_path}` and it will automatically get loaded from there. This integration is useful if you support e.g. 10 languages and want to use the same \"What's new\"-text for all languages.",
-          "Defining the version is optional, fastlane will try to automatically detect it if you don't provide one"
+          "Defining the version is optional. _fastlane_ will try to automatically detect it if you don't provide one."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/set_github_release.rb

@@ -146,11 +146,11 @@ module Fastlane
       end
 
       def self.details
-        "Creates a new release on GitHub. You must provide your GitHub Personal token
-        (get one from https://github.com/settings/tokens/new), the repository name
-        and tag name. By default that's 'master'. If the tag doesn't exist, one will be created on the commit or branch passed-in as
-        commitish. Out parameters provide the release's id, which can be used for later editing and the
-        release html link to GitHub. You can also specify a list of assets to be uploaded to the release with the upload_assets parameter."
+        [
+          "Creates a new release on GitHub. You must provide your GitHub Personal token (get one from [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new)), the repository name and tag name. By default, that's `master`.",
+          "If the tag doesn't exist, one will be created on the commit or branch passed in as commitish.",
+          "Out parameters provide the release's id, which can be used for later editing and the release HTML link to GitHub. You can also specify a list of assets to be uploaded to the release with the `:upload_assets` parameter."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/setup_circle_ci.rb

@@ -61,12 +61,15 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list(true)
+          Creates a new temporary keychain for use with match
+          Switches match to `readonly` mode to not create new profiles/cert on CI
+          Sets up log and test result paths to be easily collectible
+        LIST
+
         [
-          "- Creates a new temporary keychain for use with match",
-          "- Switches match to `readonly` mode to not create new profiles/cert on CI",
-          "- Sets up log and test result paths to be easily collectible",
-          "",
-          "This action helps with CircleCI integration, add this to the top of your Fastfile if you use CircleCI"
+          list,
+          "This action helps with CircleCI integration. Add this to the top of your Fastfile if you use CircleCI."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/setup_jenkins.rb

@@ -88,16 +88,18 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list(true)
+          Adds and unlocks keychains from Jenkins 'Keychains and Provisioning Profiles Plugin'
+          Sets code signing identity from Jenkins 'Keychains and Provisioning Profiles Plugin'
+          Sets output directory to './output' (gym, scan and backup_xcarchive)
+          Sets derived data path to './derivedData' (xcodebuild, gym, scan and clear_derived_data, carthage)
+          Produce result bundle (gym and scan)
+        LIST
+
         [
-          "- Adds and unlocks keychains from Jenkins 'Keychains and Provisioning Profiles Plugin'",
-          "- Sets code signing identity from Jenkins 'Keychains and Provisioning Profiles Plugin'",
-          "- Sets output directory to './output' (gym, scan and backup_xcarchive).",
-          "- Sets derived data path to './derivedData' (xcodebuild, gym, scan and clear_derived_data, carthage).",
-          "- Produce result bundle (gym and scan).",
-          "",
+          list,
           "This action helps with Jenkins integration. Creates own derived data for each job. All build results like IPA files and archives will be stored in the `./output` directory.",
-          "The action also works with [Keychains and Provisioning Profiles Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Keychains+and+Provisioning+Profiles+Plugin), selected keychain",
-          "will be automatically unlocked and the selected code signing identity will be used. By default this action will only work when fastlane is executed on a CI system."
+          "The action also works with [Keychains and Provisioning Profiles Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Keychains+and+Provisioning+Profiles+Plugin), the selected keychain will be automatically unlocked and the selected code signing identity will be used. By default this action will only work when _fastlane_ is executed on a CI system."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/setup_travis.rb

@@ -40,11 +40,14 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list(true)
+          Creates a new temporary keychain for use with match
+          Switches match to `readonly` mode to not create new profiles/cert on CI
+        LIST
+
         [
-          "- Creates a new temporary keychain for use with match",
-          "- Switches match to `readonly` mode to not create new profiles/cert on CI",
-          "",
-          "This action helps with Travis integration, add this to the top of your Fastfile if you use Travis"
+          list,
+          "This action helps with Travis integration. Add this to the top of your Fastfile if you use Travis."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/sh.rb

@@ -16,7 +16,7 @@ module Fastlane
       def self.details
         [
           "Allows running an arbitrary shell command.",
-          "Be aware of a specific behavior of 'sh' action with regard to the working directory. For details refer to Advanced.md"
+          "Be aware of a specific behavior of `sh` action with regard to the working directory. For details, refer to [Advanced](https://docs.fastlane.tools/advanced/#directory-behavior)."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/skip_docs.rb

@@ -27,7 +27,7 @@ module Fastlane
       end
 
       def self.details
-        "Tell _fastlane_ to not automatically create a `fastlane/README.md` when running _fastlane_. You can always trigger the creation of this file manually by running `fastlane docs`"
+        "Tell _fastlane_ to not automatically create a `fastlane/README.md` when running _fastlane_. You can always trigger the creation of this file manually by running `fastlane docs`."
       end
 
       def self.authors

data/fastlane/lib/fastlane/actions/slather.rb

@@ -110,10 +110,10 @@ module Fastlane
       end
 
       def self.details
-        return <<-eos
-Slather works with multiple code coverage formats including Xcode7 code coverage.
-Slather is available at https://github.com/SlatherOrg/slather
-        eos
+        [
+          "Slather works with multiple code coverage formats, including Xcode 7 code coverage.",
+          "Slather is available at [https://github.com/SlatherOrg/slather](https://github.com/SlatherOrg/slather)."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/sonar.rb

@@ -44,8 +44,8 @@ module Fastlane
 
       def self.details
         [
-          "See http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner for details.",
-          "It can process unit test results if formatted as junit report as shown in [xctest](#xctest) action. It can also integrate coverage reports in Cobertura format, which can be transformed into by [slather](#slather) action."
+          "See [http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner](http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) for details.",
+          "It can process unit test results if formatted as junit report as shown in [xctest](https://docs.fastlane.tools/actions/xctest/) action. It can also integrate coverage reports in Cobertura format, which can be transformed into by the [slather](https://docs.fastlane.tools/actions/slather/) action."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/ssh.rb

@@ -80,7 +80,7 @@ module Fastlane
       end
 
       def self.details
-        "Lets you execute remote commands via ssh using username/password or ssh-agent. If one of the commands in command-array returns non 0 - it fails."
+        "Lets you execute remote commands via ssh using username/password or ssh-agent. If one of the commands in command-array returns non 0, it fails."
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/swiftlint.rb

@@ -67,9 +67,6 @@ module Fastlane
         "Run swift code validation using SwiftLint"
       end
 
-      def self.details
-      end
-
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :mode,

data/fastlane/lib/fastlane/actions/tryouts.rb

@@ -62,7 +62,7 @@ module Fastlane
       end
 
       def self.details
-        "More information http://tryouts.readthedocs.org/en/latest/releases.html#create-release"
+        "More information: [http://tryouts.readthedocs.org/en/latest/releases.html#create-release](http://tryouts.readthedocs.org/en/latest/releases.html#create-release)"
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/twitter.rb

@@ -23,7 +23,7 @@ module Fastlane
       end
 
       def self.details
-        "Post a tweet on twitter. Requires you to setup an app on twitter.com and obtain consumer and access_token."
+        "Post a tweet on Twitter. Requires you to setup an app on [twitter.com](https://twitter.com) and obtain `consumer` and `access_token`."
       end
 
       def self.available_options