Skip to content
Permalink
Browse files

Fix broken markdown in actions' details (#12348)

* Fix deprecation and details content
* Fix incorrect details method declaration for the create_app_online action
* Split long detail into multiple lines
* Join broken sentences or paragraphs into fewer lines
* Split some actions' details into multiple lines
* Extract Markdown code snippets and lists into heredocs
* Fix broken markdown in actions' details
* Replace Markdown links with a human-readable format in terminal
  • Loading branch information...
revolter committed Apr 25, 2018
1 parent 6b5b324 commit 0ba38f62be629f00d16e3debac2694aa7ef2d936
Showing with 371 additions and 353 deletions.
  1. +1 βˆ’1 fastlane/lib/assets/ActionDetails.md.erb
  2. +36 βˆ’1 fastlane/lib/fastlane/action.rb
  3. +1 βˆ’3 fastlane/lib/fastlane/actions/adb.rb
  4. +1 βˆ’3 fastlane/lib/fastlane/actions/adb_devices.rb
  5. +11 βˆ’8 fastlane/lib/fastlane/actions/add_git_tag.rb
  6. +4 βˆ’1 fastlane/lib/fastlane/actions/app_store_build_number.rb
  7. +3 βˆ’4 fastlane/lib/fastlane/actions/appaloosa.rb
  8. +1 βˆ’1 fastlane/lib/fastlane/actions/appetize.rb
  9. +4 βˆ’4 fastlane/lib/fastlane/actions/badge.rb
  10. +2 βˆ’2 fastlane/lib/fastlane/actions/build_and_upload_to_appetize.rb
  11. +1 βˆ’1 fastlane/lib/fastlane/actions/chatwork.rb
  12. +1 βˆ’1 fastlane/lib/fastlane/actions/cloc.rb
  13. +5 βˆ’4 fastlane/lib/fastlane/actions/commit_github_file.rb
  14. +9 βˆ’9 fastlane/lib/fastlane/actions/commit_version_bump.rb
  15. +2 βˆ’2 fastlane/lib/fastlane/actions/copy_artifacts.rb
  16. +2 βˆ’2 fastlane/lib/fastlane/actions/crashlytics.rb
  17. +5 βˆ’6 fastlane/lib/fastlane/actions/create_app_online.rb
  18. +1 βˆ’1 fastlane/lib/fastlane/actions/danger.rb
  19. +1 βˆ’1 fastlane/lib/fastlane/actions/delete_keychain.rb
  20. +1 βˆ’1 fastlane/lib/fastlane/actions/deploygate.rb
  21. +1 βˆ’1 fastlane/lib/fastlane/actions/dotgpg_environment.rb
  22. +2 βˆ’3 fastlane/lib/fastlane/actions/download.rb
  23. +12 βˆ’9 fastlane/lib/fastlane/actions/download_dsyms.rb
  24. +2 βˆ’3 fastlane/lib/fastlane/actions/ensure_git_branch.rb
  25. +3 βˆ’5 fastlane/lib/fastlane/actions/ensure_git_status_clean.rb
  26. +2 βˆ’3 fastlane/lib/fastlane/actions/ensure_no_debug_code.rb
  27. +4 βˆ’2 fastlane/lib/fastlane/actions/ensure_xcode_version.rb
  28. +2 βˆ’2 fastlane/lib/fastlane/actions/erb.rb
  29. +1 βˆ’4 fastlane/lib/fastlane/actions/flock.rb
  30. +2 βˆ’2 fastlane/lib/fastlane/actions/frame_screenshots.rb
  31. +2 βˆ’3 fastlane/lib/fastlane/actions/get_build_number.rb
  32. +1 βˆ’1 fastlane/lib/fastlane/actions/get_build_number_repository.rb
  33. +1 βˆ’1 fastlane/lib/fastlane/actions/get_certificates.rb
  34. +42 βˆ’38 fastlane/lib/fastlane/actions/get_github_release.rb
  35. +1 βˆ’1 fastlane/lib/fastlane/actions/get_ipa_info_plist_value.rb
  36. +13 βˆ’8 fastlane/lib/fastlane/actions/get_push_certificate.rb
  37. +1 βˆ’3 fastlane/lib/fastlane/actions/get_version_number.rb
  38. +0 βˆ’4 fastlane/lib/fastlane/actions/git_commit.rb
  39. +0 βˆ’4 fastlane/lib/fastlane/actions/git_submodule_update.rb
  40. +0 βˆ’4 fastlane/lib/fastlane/actions/git_tag_exists.rb
  41. +5 βˆ’3 fastlane/lib/fastlane/actions/github_api.rb
  42. +1 βˆ’1 fastlane/lib/fastlane/actions/google_play_track_version_codes.rb
  43. +1 βˆ’3 fastlane/lib/fastlane/actions/gradle.rb
  44. +8 βˆ’5 fastlane/lib/fastlane/actions/hg_commit_version_bump.rb
  45. +1 βˆ’1 fastlane/lib/fastlane/actions/hg_ensure_clean_status.rb
  46. +1 βˆ’1 fastlane/lib/fastlane/actions/hg_push.rb
  47. +1 βˆ’1 fastlane/lib/fastlane/actions/hockey.rb
  48. +2 βˆ’2 fastlane/lib/fastlane/actions/import.rb
  49. +1 βˆ’4 fastlane/lib/fastlane/actions/import_from_git.rb
  50. +1 βˆ’2 fastlane/lib/fastlane/actions/increment_version_number.rb
  51. +1 βˆ’1 fastlane/lib/fastlane/actions/install_on_device.rb
  52. +6 βˆ’4 fastlane/lib/fastlane/actions/ipa.rb
  53. +1 βˆ’4 fastlane/lib/fastlane/actions/is_ci.rb
  54. +0 βˆ’3 fastlane/lib/fastlane/actions/jazzy.rb
  55. +2 βˆ’2 fastlane/lib/fastlane/actions/lane_context.rb
  56. +1 βˆ’1 fastlane/lib/fastlane/actions/last_git_tag.rb
  57. +2 βˆ’2 fastlane/lib/fastlane/actions/latest_testflight_build_number.rb
  58. +1 βˆ’2 fastlane/lib/fastlane/actions/modify_services.rb
  59. +1 βˆ’1 fastlane/lib/fastlane/actions/notify.rb
  60. +1 βˆ’1 fastlane/lib/fastlane/actions/number_of_commits.rb
  61. +1 βˆ’1 fastlane/lib/fastlane/actions/oclint.rb
  62. +1 βˆ’1 fastlane/lib/fastlane/actions/onesignal.rb
  63. +1 βˆ’3 fastlane/lib/fastlane/actions/opt_out_crash_reporting.rb
  64. +4 βˆ’5 fastlane/lib/fastlane/actions/opt_out_usage.rb
  65. +0 βˆ’4 fastlane/lib/fastlane/actions/pod_push.rb
  66. +5 βˆ’5 fastlane/lib/fastlane/actions/podio_item.rb
  67. +2 βˆ’2 fastlane/lib/fastlane/actions/prompt.rb
  68. +1 βˆ’5 fastlane/lib/fastlane/actions/push_to_git_remote.rb
  69. +3 βˆ’5 fastlane/lib/fastlane/actions/read_podspec.rb
  70. +1 βˆ’1 fastlane/lib/fastlane/actions/register_device.rb
  71. +8 βˆ’4 fastlane/lib/fastlane/actions/reset_git_repo.rb
  72. +11 βˆ’9 fastlane/lib/fastlane/actions/resign.rb
  73. +1 βˆ’1 fastlane/lib/fastlane/actions/rsync.rb
  74. +4 βˆ’2 fastlane/lib/fastlane/actions/s3.rb
  75. +1 βˆ’1 fastlane/lib/fastlane/actions/set_build_number_repository.rb
  76. +1 βˆ’1 fastlane/lib/fastlane/actions/set_changelog.rb
  77. +5 βˆ’5 fastlane/lib/fastlane/actions/set_github_release.rb
  78. +8 βˆ’5 fastlane/lib/fastlane/actions/setup_circle_ci.rb
  79. +10 βˆ’8 fastlane/lib/fastlane/actions/setup_jenkins.rb
  80. +7 βˆ’4 fastlane/lib/fastlane/actions/setup_travis.rb
  81. +1 βˆ’1 fastlane/lib/fastlane/actions/sh.rb
  82. +1 βˆ’1 fastlane/lib/fastlane/actions/skip_docs.rb
  83. +4 βˆ’4 fastlane/lib/fastlane/actions/slather.rb
  84. +2 βˆ’2 fastlane/lib/fastlane/actions/sonar.rb
  85. +1 βˆ’1 fastlane/lib/fastlane/actions/ssh.rb
  86. +0 βˆ’3 fastlane/lib/fastlane/actions/swiftlint.rb
  87. +1 βˆ’1 fastlane/lib/fastlane/actions/tryouts.rb
  88. +1 βˆ’1 fastlane/lib/fastlane/actions/twitter.rb
  89. +4 βˆ’2 fastlane/lib/fastlane/actions/unlock_keychain.rb
  90. +14 βˆ’7 fastlane/lib/fastlane/actions/update_fastlane.rb
  91. +4 βˆ’3 fastlane/lib/fastlane/actions/update_project_code_signing.rb
  92. +6 βˆ’7 fastlane/lib/fastlane/actions/update_project_provisioning.rb
  93. +1 βˆ’1 fastlane/lib/fastlane/actions/update_project_team.rb
  94. +1 βˆ’1 fastlane/lib/fastlane/actions/update_urban_airship_configuration.rb
  95. +1 βˆ’2 fastlane/lib/fastlane/actions/update_url_schemes.rb
  96. +1 βˆ’7 fastlane/lib/fastlane/actions/upload_symbols_to_crashlytics.rb
  97. +6 βˆ’8 fastlane/lib/fastlane/actions/upload_symbols_to_sentry.rb
  98. +2 βˆ’4 fastlane/lib/fastlane/actions/upload_to_app_store.rb
  99. +2 βˆ’2 fastlane/lib/fastlane/actions/upload_to_testflight.rb
  100. +1 βˆ’5 fastlane/lib/fastlane/actions/verify_xcode.rb
  101. +3 βˆ’3 fastlane/lib/fastlane/actions/version_bump_podspec.rb
  102. +5 βˆ’5 fastlane/lib/fastlane/actions/xcode_server_get_assets.rb
  103. +1 βˆ’1 fastlane/lib/fastlane/actions/xcov.rb
  104. +3 βˆ’3 fastlane/lib/fastlane/actions/xctool.rb
  105. +0 βˆ’3 fastlane/lib/fastlane/actions/zip.rb
  106. +8 βˆ’2 fastlane/lib/fastlane/documentation/actions_list.rb
@@ -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 %> ||
@@ -46,7 +46,7 @@ def self.description
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 @@ def self.deprecated_notes
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
@@ -19,9 +19,7 @@ def self.description
end

def self.details
[
"see adb --help for more details"
].join("\n")
"see adb --help for more details"
end

def self.available_options
@@ -19,9 +19,7 @@ def self.description
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
@@ -26,15 +26,18 @@ def self.description
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

@@ -155,7 +155,10 @@ def self.output
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
@@ -173,10 +173,9 @@ def self.description

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

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

@@ -38,11 +38,11 @@ def self.description

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

@@ -39,8 +39,8 @@ def self.description

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

@@ -72,7 +72,7 @@ def self.is_supported?(platform)
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
@@ -28,7 +28,7 @@ def self.description
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

@@ -77,10 +77,11 @@ def self.description
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
@@ -184,18 +184,18 @@ def self.available_options
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

@@ -48,8 +48,8 @@ def self.description

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

@@ -161,8 +161,8 @@ def self.author

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

@@ -25,13 +25,12 @@ def self.description
"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
@@ -34,7 +34,7 @@ def self.description
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

@@ -23,7 +23,7 @@ def self.run(params)
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
@@ -104,7 +104,7 @@ def self.description

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
@@ -17,7 +17,7 @@ def self.description
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
@@ -31,9 +31,8 @@ def self.description

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

@@ -124,16 +124,19 @@ def self.description
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

@@ -25,9 +25,8 @@ def self.description

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

@@ -30,11 +30,9 @@ def self.description

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

@@ -56,9 +56,8 @@ def self.description

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

@@ -29,8 +29,10 @@ def self.description
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

0 comments on commit 0ba38f6

Please sign in to comment.
You can’t perform that action at this time.