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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 932dac01c907852cb919b05b3093e81657858624
-  data.tar.gz: 1f838b607c8af73be252538774950a0bf7f685a9
+  metadata.gz: 0dc2308fd48bff85fe0bd5efbdb6fdcc25246fc1
+  data.tar.gz: 954a3934b9e99a4b3f3b4c3715223ca7b0cc5d8a
 SHA512:
-  metadata.gz: 2b080d33fad88e7204b8c211f03278d9c8f59925f9566909e4214739f10d0ed82e7e79bf5bc5e1f9417f448610eea7218b6beb6c649300362c18b61e85813488
-  data.tar.gz: 8cf17e3115ab84ca7337970e0bc1a3d0140a0eb16ed79632be0c95364d53d7e0a6f922f8eb5a2b7ed22a071f8f5a856abb3e3f794210e90bd9da813635d5358e
+  metadata.gz: d74855863d7be32610b23fca788a37d160f9b75ab0396d434d41c2280a3cd8e866989d710b3cb858bc142a52d97edaa97ea524a8f7c5954787c95170f526ccb5
+  data.tar.gz: a7e4b36252fc51f91dce352895d0e590f42fe4f378276ad79f84b2d502c1634ae98596b22158ff04c99c7733a0a396a59e9bed8848645122d346c6d7ae31c598

data/fastlane/lib/assets/ActionDetails.md.erb

@@ -14,7 +14,7 @@ To modify it, go to its source at https://github.com/fastlane/fastlane/blob/mast
 <%= @custom_content %>
 <hr />
 <% else %>
-<%= "> #{action.details.gsub("\n", "<br>")}" unless action.details.to_s.empty? %>
+<%= "> #{action.details.gsub(/(?<!\|)\n/, "<br>").gsub(/\|(?=\n|$)/, "")}" unless action.details.to_s.empty? %>
 <% end %>
 
 <%= action.action_name %> ||

data/fastlane/lib/fastlane/action.rb

@@ -46,7 +46,7 @@ module Fastlane
     end
 
     def self.details
-      nil # this is your change to provide a more detailed description of this action
+      nil # this is your chance to provide a more detailed description of this action
     end
 
     def self.available_options
@@ -152,3 +152,38 @@ module Fastlane
     end
   end
 end
+
+class String
+  def markdown_preserve_newlines
+    self.gsub(/(\n|$)/, '|\1') # prepend new lines with "|" so the erb template knows *not* to replace them with "<br>"s
+  end
+
+  def markdown_sample(is_first = false)
+    self.markdown_clean_heredoc!
+    self.markdown_details(is_first)
+  end
+
+  def markdown_list(is_first = false)
+    self.markdown_clean_heredoc!
+    self.gsub!(/^/, "- ") # add list dashes
+    self.prepend(">") unless is_first # the empty line that will be added breaks the quote
+    self.markdown_details(is_first)
+  end
+
+  def markdown_details(is_first)
+    self.prepend("\n") unless is_first
+    self << "\n>" # continue the quote
+    self.markdown_preserve_newlines
+  end
+
+  def markdown_clean_heredoc!
+    self.chomp! # remove the last new line added by the heredoc
+    self.dedent! # remove the leading whitespace (similar to the squigly heredoc `<<~`)
+  end
+
+  def dedent!
+    first_line_indent = self.match(/^\s*/)[0]
+
+    self.gsub!(/^#{first_line_indent}/, "")
+  end
+end

data/fastlane/lib/fastlane/actions/adb.rb

@@ -19,9 +19,7 @@ module Fastlane
       end
 
       def self.details
-        [
-          "see adb --help for more details"
-        ].join("\n")
+        "see adb --help for more details"
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/adb_devices.rb

@@ -19,9 +19,7 @@ module Fastlane
       end
 
       def self.details
-        [
-          "Fetches device list via adb, e.g. run an adb command on all connected devices."
-        ].join("\n")
+        "Fetches device list via adb, e.g. run an adb command on all connected devices."
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/add_git_tag.rb

@@ -26,15 +26,18 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list
+          `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'
+          `postfix` is anything you want to stick at the end of the version number, e.g. '-RC1'
+          `build_number` is the build number, which defaults to the value emitted by the `increment_build_number` action
+        LIST
+
         [
-          "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'",
-          "- `postfix` is anything you want to stick at the end of the version number, e.g. '-RC1'",
-          "- `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`"
+          "This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number>`, where:".markdown_preserve_newlines,
+          list,
+          "For example, for build 1234 in the 'appstore' lane, it will tag the commit with `builds/appstore/1234`."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/app_store_build_number.rb

@@ -155,7 +155,10 @@ module Fastlane
       end
 
       def self.details
-        "Returns the current build number of either the live or testflight version - it is useful for getting the build_number of the current or ready-for-sale app version, and it also works on non-live testflight version. If you need to handle more build-trains please see `latest_testflight_build_number`"
+        [
+          "Returns the current build number of either the live or testflight version - it is useful for getting the build_number of the current or ready-for-sale app version, and it also works on non-live testflight version.",
+          "If you need to handle more build-trains please see `latest_testflight_build_number`."
+        ].join("\n")
       end
 
       def self.example_code

data/fastlane/lib/fastlane/actions/appaloosa.rb

@@ -173,10 +173,9 @@ module Fastlane
 
       def self.details
         [
-          "Appaloosa is a private mobile application store. This action ",
-          "offers a quick deployment on the platform. You can create an ",
-          "account, push to your existing account, or manage your user ",
-          "groups. We accept iOS and Android applications."
+          "Appaloosa is a private mobile application store. This action offers a quick deployment on the platform.",
+          "You can create an account, push to your existing account, or manage your user groups.",
+          "We accept iOS and Android applications."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/appetize.rb

@@ -94,7 +94,7 @@ module Fastlane
         [
           "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)"
+          "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
 

data/fastlane/lib/fastlane/actions/badge.rb

@@ -38,11 +38,11 @@ module Fastlane
 
       def self.details
         [
-          "[Please use the badge fastlane plugin instead: https://github.com/HazAT/fastlane-plugin-badge]",
+          "Please use the [badge plugin](https://github.com/HazAT/fastlane-plugin-badge) instead.",
           "This action will add a light/dark badge onto your app icon.",
-          "You can also provide your custom badge/overlay or add an shield for more customization more info:",
-          "https://github.com/HazAT/badge",
-          "**Note** If you want to reset the badge back to default you can use `sh 'git checkout -- <path>/Assets.xcassets/'`"
+          "You can also provide your custom badge/overlay or add a shield for more customization.",
+          "More info: [https://github.com/HazAT/badge](https://github.com/HazAT/badge)",
+          "**Note**: If you want to reset the badge back to default, you can use `sh 'git checkout -- <path>/Assets.xcassets/'`."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/build_and_upload_to_appetize.rb

@@ -39,8 +39,8 @@ module Fastlane
 
       def self.details
         [
-          "This should be called from danger",
-          "More information in the [device_grid guide](https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/device_grid/README.md)"
+          "This should be called from danger.",
+          "More information in the [device_grid guide](https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/device_grid/README.md)."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/chatwork.rb

@@ -72,7 +72,7 @@ module Fastlane
       end
 
       def self.details
-        "Information on how to obtain an API token: http://developer.chatwork.com/ja/authenticate.html"
+        "Information on how to obtain an API token: [http://developer.chatwork.com/ja/authenticate.html](http://developer.chatwork.com/ja/authenticate.html)"
       end
 
       def self.example_code

data/fastlane/lib/fastlane/actions/cloc.rb

@@ -28,7 +28,7 @@ module Fastlane
       def self.details
         [
           "This action will run cloc to generate a SLOC report that the Jenkins SLOCCount plugin can read.",
-          "See https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin and https://github.com/AlDanial/cloc for more information."
+          "See [https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin](https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin) and [https://github.com/AlDanial/cloc](https://github.com/AlDanial/cloc) for more information."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/commit_github_file.rb

@@ -77,10 +77,11 @@ module Fastlane
       end
 
       def self.details
-        "Commits a file directly to GitHub. You must provide your GitHub Personal token
-        (get one from https://github.com/settings/tokens/new), the repository name and the relative file path from the root git project.
-        Out parameters provide the commit sha created, which can be used for later usage for examples such as releases, the direct download link and the full response JSON.
-        Documentation: https://developer.github.com/v3/repos/contents/#create-a-file"
+        [
+          "Commits a file directly to 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 the relative file path from the root git project.",
+          "Out parameters provide the commit sha created, which can be used for later usage for examples such as releases, the direct download link and the full response JSON.",
+          "Documentation: [https://developer.github.com/v3/repos/contents/#create-a-file](https://developer.github.com/v3/repos/contents/#create-a-file)."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/commit_version_bump.rb

@@ -184,18 +184,18 @@ module Fastlane
       end
 
       def self.details
+        list = <<-LIST.markdown_list
+          All `.plist` files
+          The `.xcodeproj/project.pbxproj` file
+        LIST
+
         [
           "This action will create a 'Version Bump' commit in your repo. Useful in conjunction with `increment_build_number`.",
-          "",
-          "It checks the repo to make sure that only the relevant files have changed, these are the files that `increment_build_number` (`agvtool`) touches:",
-          "- All .plist files",
-          "- The `.xcodeproj/project.pbxproj` file",
-          "",
+          "It checks the repo to make sure that only the relevant files have changed. These are the files that `increment_build_number` (`agvtool`) touches:".markdown_preserve_newlines,
+          list,
           "Then commits those files to the repo.",
-          "",
-          "Customize the message with the `:message` option, defaults to 'Version Bump'",
-          "",
-          "If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the _ipa_ and or _sigh_ actions, then you can use the `clean_build_artifacts` action to clean those temporary files up before running this action."
+          "Customize the message with the `:message` option. It defaults to 'Version Bump'.",
+          "If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the _ipa_ and or _sigh_ actions, then you can use the [clean_build_artifacts](https://docs.fastlane.tools/actions/clean_build_artifacts/) action to clean those temporary files up before running this action."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/copy_artifacts.rb

@@ -48,8 +48,8 @@ module Fastlane
 
       def self.details
         [
-          "This action copies artifacts to a target directory. It's useful if you have a CI that will pick up these artifacts and attach them to the build. Useful e.g. for storing your `.ipa`s, `.dSYM.zip`s, `.mobileprovision`s, `.cert`s",
-          "Make sure your target_path is gitignored, and if you use `reset_git_repo`, make sure the artifacts are added to the exclude list"
+          "This action copies artifacts to a target directory. It's useful if you have a CI that will pick up these artifacts and attach them to the build. Useful e.g. for storing your `.ipa`s, `.dSYM.zip`s, `.mobileprovision`s, `.cert`s.",
+          "Make sure your `:target_path` is ignored from git, and if you use `reset_git_repo`, make sure the artifacts are added to the exclude list."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/crashlytics.rb

@@ -161,8 +161,8 @@ module Fastlane
 
       def self.details
         [
-          "Additionally you can specify `notes`, `emails`, `groups` and `notifications`.",
-          "Distributing to Groups: When using the `groups` parameter, it's important to use the group **alias** names for each group you'd like to distribute to. A group's alias can be found in the web UI. If you're viewing the Beta page, you can open the groups dialog here:"
+          "Additionally, you can specify `notes`, `emails`, `groups` and `notifications`.",
+          "Distributing to Groups: When using the `groups` parameter, it's important to use the group **alias** names for each group you'd like to distribute to. A group's alias can be found in the web UI. If you're viewing the Beta page, you can open the groups dialog by clicking the 'Manage Groups' button."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/create_app_online.rb

@@ -25,13 +25,12 @@ module Fastlane
         "Creates the given application on iTC and the Dev Portal (via _produce_)"
       end
 
-      def details
+      def self.details
         [
-          'Create new apps on iTunes Connect and Apple Developer Portal via _produce_.',
-          'If the app already exists, `create_app_online` will not do anything.',
-          'For more information about produce, visit its documentation page:',
-          'https://docs.fastlane.tools/actions/produce/'
-        ].join(' ')
+          "Create new apps on iTunes Connect and Apple Developer Portal via _produce_.",
+          "If the app already exists, `create_app_online` will not do anything.",
+          "For more information about _produce_, visit its documentation page: [https://docs.fastlane.tools/actions/produce/](https://docs.fastlane.tools/actions/produce/)."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/danger.rb

@@ -34,7 +34,7 @@ module Fastlane
       def self.details
         [
           "Formalize your Pull Request etiquette.",
-          "More information: https://github.com/danger/danger"
+          "More information: [https://github.com/danger/danger](https://github.com/danger/danger)."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/delete_keychain.rb

@@ -23,7 +23,7 @@ module Fastlane
       end
 
       def self.details
-        "Keychains can be deleted after being creating with `create_keychain`"
+        "Keychains can be deleted after being created with `create_keychain`"
       end
 
       def self.description

data/fastlane/lib/fastlane/actions/deploygate.rb

@@ -104,7 +104,7 @@ module Fastlane
 
       def self.details
         [
-          "You can retrieve your username and API token on [your settings page](https://deploygate.com/settings)",
+          "You can retrieve your username and API token on [your settings page](https://deploygate.com/settings).",
           "More information about the available options can be found in the [DeployGate Push API document](https://deploygate.com/docs/api)."
         ].join("\n")
       end

data/fastlane/lib/fastlane/actions/dotgpg_environment.rb

@@ -17,7 +17,7 @@ module Fastlane
       end
 
       def self.details
-        "More information about dotgpg can be found at https://github.com/ConradIrwin/dotgpg"
+        "More information about dotgpg can be found at [https://github.com/ConradIrwin/dotgpg](https://github.com/ConradIrwin/dotgpg)."
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/download.rb

@@ -31,9 +31,8 @@ module Fastlane
 
       def self.details
         [
-          "Specify the URL to download and get the content as a return value",
-          "For more advanced networking code, use the Ruby functions instead:",
-          "http://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html"
+          "Specify the URL to download and get the content as a return value.",
+          "For more advanced networking code, use the Ruby functions instead: [http://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html](http://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html)."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/download_dsyms.rb

@@ -124,16 +124,19 @@ module Fastlane
       end
 
       def self.details
+        sample = <<-SAMPLE.markdown_sample
+          ```ruby
+          lane :refresh_dsyms do
+            download_dsyms                  # Download dSYM files from iTC
+            upload_symbols_to_crashlytics   # Upload them to Crashlytics
+            clean_build_artifacts           # Delete the local dSYM files
+          end
+          ```
+        SAMPLE
+
         [
-          "This action downloads dSYM files from Apple iTunes Connect after",
-          "the ipa got re-compiled by Apple. Useful if you have Bitcode enabled",
-          "```ruby",
-          "lane :refresh_dsyms do",
-          "  download_dsyms                  # Download dSYM files from iTC",
-          "  upload_symbols_to_crashlytics   # Upload them to Crashlytics",
-          "  clean_build_artifacts           # Delete the local dSYM files",
-          "end",
-          "```"
+          "This action downloads dSYM files from Apple iTunes Connect after the ipa gets re-compiled by Apple. Useful if you have Bitcode enabled.".markdown_preserve_newlines,
+          sample
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/ensure_git_branch.rb

@@ -25,9 +25,8 @@ module Fastlane
 
       def self.details
         [
-          'This action will check if your git repo is checked out to a specific branch.',
-          'You may only want to make releases from a specific branch, so `ensure_git_branch`',
-          'will stop a lane if it was accidentally executed on an incorrect branch.'
+          "This action will check if your git repo is checked out to a specific branch.",
+          "You may only want to make releases from a specific branch, so `ensure_git_branch` will stop a lane if it was accidentally executed on an incorrect branch."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -30,11 +30,9 @@ module Fastlane
 
       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`.'
+          "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
 

data/fastlane/lib/fastlane/actions/ensure_no_debug_code.rb

@@ -56,9 +56,8 @@ module Fastlane
 
       def self.details
         [
-          "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"
+          "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 codebase or if you have things like `// TO DO` or similar."
         ].join("\n")
       end
 

data/fastlane/lib/fastlane/actions/ensure_xcode_version.rb

@@ -29,8 +29,10 @@ module Fastlane
       end
 
       def self.details
-        "If building your app requires a specific version of Xcode, you can invoke this command before using gym.\n
-        For example, to ensure that a beta version of Xcode is not accidentally selected to build, which would make uploading to TestFlight fail."
+        [
+          "If building your app requires a specific version of Xcode, you can invoke this command before using gym.",
+          "For example, to ensure that a beta version of Xcode is not accidentally selected to build, which would make uploading to TestFlight fail."
+        ].join("\n")
       end
 
       def self.available_options

data/fastlane/lib/fastlane/actions/erb.rb

@@ -19,8 +19,8 @@ module Fastlane
 
       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, it returns the rendered template as string."
         ].join("\n")
       end