Update docs for latest fastlane release 2.211.0 (actions.md, availabl…

…e-plugins.md) 🚀
fastlane · Nov 12, 2022 · 73d2e8c · 73d2e8c
1 parent ae3922f
commit 73d2e8c
Show file tree

Hide file tree

Showing 21 changed files with 12,782 additions and 11,052 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/fastlane/fastlane
-  revision: 272063487b02b52510bb83172827fcbc336f4a55
+  revision: 8e456d608937ea51ba9306ee501e583da0eeca9a
   specs:
-    fastlane (2.210.1)
+    fastlane (2.211.0)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -53,20 +53,20 @@ GEM
     ast (2.4.2)
     atomos (0.1.3)
     aws-eventstream (1.2.0)
-    aws-partitions (1.636.0)
-    aws-sdk-core (3.154.0)
+    aws-partitions (1.660.0)
+    aws-sdk-core (3.167.0)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.58.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-kms (1.59.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.114.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-s3 (1.117.1)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
-    aws-sigv4 (1.5.1)
+    aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     claide (1.1.0)
@@ -100,7 +100,7 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
     emoji_regex (3.2.3)
-    excon (0.92.5)
+    excon (0.94.0)
     faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -136,9 +136,9 @@ GEM
     git (1.12.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
-    google-apis-androidpublisher_v3 (0.28.0)
-      google-apis-core (>= 0.9.0, < 2.a)
-    google-apis-core (0.9.0)
+    google-apis-androidpublisher_v3 (0.31.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-core (0.9.1)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -147,27 +147,27 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
-    google-apis-iamcredentials_v1 (0.15.0)
-      google-apis-core (>= 0.9.0, < 2.a)
-    google-apis-playcustomapp_v1 (0.11.0)
+    google-apis-iamcredentials_v1 (0.16.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-playcustomapp_v1 (0.12.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-storage_v1 (0.19.0)
       google-apis-core (>= 0.9.0, < 2.a)
-    google-apis-storage_v1 (0.17.0)
-      google-apis-core (>= 0.7, < 2.a)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.3.0)
-    google-cloud-storage (1.42.0)
+    google-cloud-storage (1.44.0)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
       google-apis-iamcredentials_v1 (~> 0.1)
-      google-apis-storage_v1 (~> 0.17.0)
+      google-apis-storage_v1 (~> 0.19.0)
       google-cloud-core (~> 1.6)
       googleauth (>= 0.16.2, < 2.a)
       mini_mime (~> 1.0)
-    googleauth (1.2.0)
+    googleauth (1.3.0)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)

diff --git a/docs/generated/actions.md b/docs/generated/actions.md
@@ -71,26 +71,25 @@ Action | Description | Supported Platforms
 <a href="/actions/gradle/">gradle</a> | All gradle related actions, including building and testing your Android app | ios, android
 <a href="/actions/clear_derived_data/">clear_derived_data</a> | Deletes the Xcode Derived Data | ios, mac
 <a href="/actions/adb/">adb</a> | Run ADB Actions | android
-<a href="/actions/xcversion/">xcversion</a> | Select an Xcode to use by version specifier | ios, mac
 <a href="/actions/xcodebuild/">xcodebuild</a> | Use the `xcodebuild` command to build and sign your app | ios, mac
 <a href="/actions/carthage/">carthage</a> | Runs `carthage` for your project | ios, mac
 <a href="/actions/xcode_select/">xcode_select</a> | Change the xcode-path to use. Useful for beta versions of Xcode | ios, mac
 <a href="/actions/ensure_xcode_version/">ensure_xcode_version</a> | Ensure the right version of Xcode is used | ios, mac
 <a href="/actions/clean_cocoapods_cache/">clean_cocoapods_cache</a> | Remove the cache for pods | ios, mac
 <a href="/actions/verify_xcode/">verify_xcode</a> | Verifies that the Xcode installation is properly signed by Apple | ios, mac
-<a href="/actions/xcode_install/">xcode_install</a> | Make sure a certain version of Xcode is installed | ios, mac
 <a href="/actions/verify_pod_keys/">verify_pod_keys</a> | Verifies all keys referenced from the Podfile are non-empty | ios, mac
-<a href="/actions/spm/">spm</a> | Runs Swift Package Manager on your project | ios, android, mac
-<a href="/actions/xcclean/">xcclean</a> | Cleans the project using `xcodebuild` | ios, mac
 <a href="/actions/build_android_app/">build_android_app</a> | Alias for the `gradle` action | ios, android
+<a href="/actions/xctest/">xctest</a> | Runs tests on the given simulator | ios, mac
+<a href="/actions/xcarchive/">xcarchive</a> | Archives the project using `xcodebuild` | ios, mac
+<a href="/actions/create_xcframework/">create_xcframework</a> | Package multiple build configs of a library/framework into a single xcframework | ios, mac
 <a href="/actions/xcbuild/">xcbuild</a> | Builds the project using `xcodebuild` | ios, mac
+<a href="/actions/spm/">spm</a> | Runs Swift Package Manager on your project | ios, android, mac
+<a href="/actions/build_app/">build_app</a> | Easily build and sign your app (via _gym_) | ios, mac
+<a href="/actions/xcodes/">xcodes</a> | Make sure a certain version of Xcode is installed, installing it only if needed | ios, mac
 <a href="/actions/xcexport/">xcexport</a> | Exports the project using `xcodebuild` | ios, mac
 <a href="/actions/build_mac_app/">build_mac_app</a> | Alias for the `build_app` action but only for macOS | mac
+<a href="/actions/xcclean/">xcclean</a> | Cleans the project using `xcodebuild` | ios, mac
 <a href="/actions/build_ios_app/">build_ios_app</a> | Alias for the `build_app` action but only for iOS | ios
-<a href="/actions/build_app/">build_app</a> | Easily build and sign your app (via _gym_) | ios, mac
-<a href="/actions/xcarchive/">xcarchive</a> | Archives the project using `xcodebuild` | ios, mac
-<a href="/actions/xctest/">xctest</a> | Runs tests on the given simulator | ios, mac
-<a href="/actions/create_xcframework/">create_xcframework</a> | Package multiple build configs of a library/framework into a single xcframework | ios, mac
 
 
 
@@ -101,8 +100,8 @@ Action | Description | Supported Platforms
 <a href="/actions/snapshot/">snapshot</a> | Alias for the `capture_ios_screenshots` action | ios, mac
 <a href="/actions/screengrab/">screengrab</a> | Alias for the `capture_android_screenshots` action | android
 <a href="/actions/frameit/">frameit</a> | Alias for the `frame_screenshots` action | ios, android, mac
-<a href="/actions/capture_android_screenshots/">capture_android_screenshots</a> | Automated localized screenshots of your Android app (via _screengrab_) | android
 <a href="/actions/frame_screenshots/">frame_screenshots</a> | Adds device frames around all screenshots (via _frameit_) | ios, android, mac
+<a href="/actions/capture_android_screenshots/">capture_android_screenshots</a> | Automated localized screenshots of your Android app (via _screengrab_) | android
 <a href="/actions/capture_ios_screenshots/">capture_ios_screenshots</a> | Generate new localized screenshots on multiple devices (via _snapshot_) | ios, mac
 <a href="/actions/capture_screenshots/">capture_screenshots</a> | Alias for the `capture_ios_screenshots` action | ios, mac
 
@@ -145,12 +144,12 @@ Action | Description | Supported Platforms
 <a href="/actions/register_devices/">register_devices</a> | Registers new devices to the Apple Dev Portal | ios, mac
 <a href="/actions/register_device/">register_device</a> | Registers a new device to the Apple Dev Portal | ios
 <a href="/actions/get_provisioning_profile/">get_provisioning_profile</a> | Generates a provisioning profile, saving it in the current folder (via _sigh_) | ios, mac
-<a href="/actions/sync_code_signing/">sync_code_signing</a> | Easily sync your certificates and profiles across your team (via _match_) | ios, mac
 <a href="/actions/install_provisioning_profile/">install_provisioning_profile</a> | Install provisioning profile from path | ios, mac
-<a href="/actions/match_nuke/">match_nuke</a> | Easily nuke your certificate and provisioning profiles (via _match_) | ios, mac
 <a href="/actions/notarize/">notarize</a> | Notarizes a macOS app | mac
-<a href="/actions/get_certificates/">get_certificates</a> | Create new iOS code signing certificates (via _cert_) | ios
+<a href="/actions/match_nuke/">match_nuke</a> | Easily nuke your certificate and provisioning profiles (via _match_) | ios, mac
+<a href="/actions/sync_code_signing/">sync_code_signing</a> | Easily sync your certificates and profiles across your team (via _match_) | ios, mac
 <a href="/actions/update_code_signing_settings/">update_code_signing_settings</a> | Configures Xcode's Codesigning options | ios, mac
+<a href="/actions/get_certificates/">get_certificates</a> | Create new iOS code signing certificates (via _cert_) | ios
 
 
 
@@ -203,10 +202,10 @@ Action | Description | Supported Platforms
 <a href="/actions/supply/">supply</a> | Alias for the `upload_to_play_store` action | android
 <a href="/actions/appstore/">appstore</a> | Alias for the `upload_to_app_store` action | ios, mac
 <a href="/actions/upload_to_play_store/">upload_to_play_store</a> | Upload metadata, screenshots and binaries to Google Play (via _supply_) | android
-<a href="/actions/upload_to_play_store_internal_app_sharing/">upload_to_play_store_internal_app_sharing</a> | Upload binaries to Google Play Internal App Sharing (via _supply_) | android
+<a href="/actions/upload_to_app_store/">upload_to_app_store</a> | Upload metadata and binary to App Store Connect (via _deliver_) | ios, mac
 <a href="/actions/download_from_play_store/">download_from_play_store</a> | Download metadata and binaries from Google Play (via _supply_) | android
+<a href="/actions/upload_to_play_store_internal_app_sharing/">upload_to_play_store_internal_app_sharing</a> | Upload binaries to Google Play Internal App Sharing (via _supply_) | android
 <a href="/actions/download_app_privacy_details_from_app_store/">download_app_privacy_details_from_app_store</a> | Download App Privacy Details from an app in App Store Connect | ios, mac
-<a href="/actions/upload_to_app_store/">upload_to_app_store</a> | Upload metadata and binary to App Store Connect (via _deliver_) | ios, mac
 <a href="/actions/upload_app_privacy_details_to_app_store/">upload_app_privacy_details_to_app_store</a> | Upload App Privacy Details for an app in App Store Connect | ios, mac
 
 
@@ -241,8 +240,8 @@ Action | Description | Supported Platforms
 <a href="/actions/hg_add_tag/">hg_add_tag</a> | This will add a hg tag to the current branch | ios, android, mac
 <a href="/actions/github_api/">github_api</a> | Call a GitHub API endpoint and get the resulting JSON response | ios, android, mac
 <a href="/actions/git_remote_branch/">git_remote_branch</a> | Returns the name of the current git remote default branch | ios, android, mac
-<a href="/actions/git_submodule_update/">git_submodule_update</a> | Executes a git submodule update command | ios, android, mac
 <a href="/actions/commit_github_file/">commit_github_file</a> | This will commit a file directly on GitHub via the API | ios, android, mac
+<a href="/actions/git_submodule_update/">git_submodule_update</a> | Executes a git submodule update command | ios, android, mac
 
 
 
@@ -272,8 +271,8 @@ Action | Description | Supported Platforms
 <a href="/actions/download_dsyms/">download_dsyms</a> | Download dSYM files from App Store Connect for Bitcode apps | ios
 <a href="/actions/app_store_build_number/">app_store_build_number</a> | Returns the current build_number of either live or edit version | ios, mac
 <a href="/actions/set_changelog/">set_changelog</a> | Set the changelog for all languages on App Store Connect | ios, mac
-<a href="/actions/create_app_online/">create_app_online</a> | Creates the given application on iTC and the Dev Portal (via _produce_) | ios
 <a href="/actions/check_app_store_metadata/">check_app_store_metadata</a> | Check your app's metadata before you submit your app to review (via _precheck_) | ios
+<a href="/actions/create_app_online/">create_app_online</a> | Creates the given application on iTC and the Dev Portal (via _produce_) | ios
 <a href="/actions/app_store_connect_api_key/">app_store_connect_api_key</a> | Load the App Store Connect API token to use in other fastlane tools and actions | ios, mac
 
 
@@ -338,26 +337,26 @@ Action | Description | Supported Platforms
 <a href="/actions/build_and_upload_to_appetize/">build_and_upload_to_appetize</a> | Generate and upload an ipa file to appetize.io | ios
 <a href="/actions/update_icloud_container_identifiers/">update_icloud_container_identifiers</a> | This action changes the iCloud container identifiers in the entitlements file | ios
 <a href="/actions/sh/">sh</a> | Runs a shell command | ios, android, mac
-<a href="/actions/environment_variable/">environment_variable</a> | Sets/gets env vars for Fastlane.swift. Don't use in ruby, use `ENV[key] = val` | ios, android, mac
+<a href="/actions/google_play_track_version_codes/">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track | android
+<a href="/actions/get_managed_play_store_publishing_rights/">get_managed_play_store_publishing_rights</a> | Obtain publishing rights for custom apps on Managed Google Play Store | android
 <a href="/actions/spaceship_stats/">spaceship_stats</a> | Print out Spaceship stats from this session (number of request to each domain) | ios, android, mac
+<a href="/actions/ensure_bundle_exec/">ensure_bundle_exec</a> | Raises an exception if not using `bundle exec` to run fastlane | ios, android, mac
 <a href="/actions/modify_services/">modify_services</a> | Modifies the services of the app created on Developer Portal | ios
-<a href="/actions/min_fastlane_version/">min_fastlane_version</a> | Verifies the minimum fastlane version required | ios, android, mac
-<a href="/actions/google_play_track_version_codes/">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track | android
-<a href="/actions/ruby_version/">ruby_version</a> | Verifies the minimum ruby version required | ios, android, mac
-<a href="/actions/setup_travis/">setup_travis</a> | Setup the keychain and match to work with Travis CI | ios, android, mac
 <a href="/actions/ensure_env_vars/">ensure_env_vars</a> | Raises an exception if the specified env vars are not set | ios, android, mac
+<a href="/actions/setup_ci/">setup_ci</a> | Setup the keychain and match to work with CI | ios, mac
+<a href="/actions/spaceship_logs/">spaceship_logs</a> | Find, print, and copy Spaceship logs | ios, android, mac
 <a href="/actions/create_app_on_managed_play_store/">create_app_on_managed_play_store</a> | Create Managed Google Play Apps | android
-<a href="/actions/echo/">echo</a> | Alias for the `puts` action | ios, android, mac
-<a href="/actions/setup_circle_ci/">setup_circle_ci</a> | Setup the keychain and match to work with CircleCI | ios, android, mac
-<a href="/actions/validate_play_store_json_key/">validate_play_store_json_key</a> | Validate that the Google Play Store `json_key` works | android
-<a href="/actions/ensure_bundle_exec/">ensure_bundle_exec</a> | Raises an exception if not using `bundle exec` to run fastlane | ios, android, mac
 <a href="/actions/opt_out_usage/">opt_out_usage</a> | This will stop uploading the information which actions were run | ios, android, mac
 <a href="/actions/println/">println</a> | Alias for the `puts` action | ios, android, mac
+<a href="/actions/setup_circle_ci/">setup_circle_ci</a> | Setup the keychain and match to work with CircleCI | ios, android, mac
 <a href="/actions/plugin_scores/">plugin_scores</a> | [31mNo description provided[0m | ios, android, mac
-<a href="/actions/setup_ci/">setup_ci</a> | Setup the keychain and match to work with CI | ios, mac
-<a href="/actions/spaceship_logs/">spaceship_logs</a> | Find, print, and copy Spaceship logs | ios, android, mac
 <a href="/actions/google_play_track_release_names/">google_play_track_release_names</a> | Retrieves release names for a Google Play track | android
-<a href="/actions/get_managed_play_store_publishing_rights/">get_managed_play_store_publishing_rights</a> | Obtain publishing rights for custom apps on Managed Google Play Store | android
+<a href="/actions/echo/">echo</a> | Alias for the `puts` action | ios, android, mac
+<a href="/actions/validate_play_store_json_key/">validate_play_store_json_key</a> | Validate that the Google Play Store `json_key` works | android
+<a href="/actions/min_fastlane_version/">min_fastlane_version</a> | Verifies the minimum fastlane version required | ios, android, mac
+<a href="/actions/ruby_version/">ruby_version</a> | Verifies the minimum ruby version required | ios, android, mac
+<a href="/actions/setup_travis/">setup_travis</a> | Setup the keychain and match to work with Travis CI | ios, android, mac
+<a href="/actions/environment_variable/">environment_variable</a> | Sets/gets env vars for Fastlane.swift. Don't use in ruby, use `ENV[key] = val` | ios, android, mac
 
 
 
@@ -366,11 +365,13 @@ Action | Description | Supported Platforms
 Action | Description | Supported Platforms
 ---|---|---
 <a href="/actions/hockey/">hockey</a> | Refer to [App Center](https://github.com/Microsoft/fastlane-plugin-appcenter/) | ios, android, mac
+<a href="/actions/xcversion/">xcversion</a> | Select an Xcode to use by version specifier | ios, mac
 <a href="/actions/badge/">badge</a> | Automatically add a badge to your app icon | ios, android, mac
 <a href="/actions/automatic_code_signing/">automatic_code_signing</a> | Configures Xcode's Codesigning options | ios, mac
 <a href="/actions/s3/">s3</a> | Generates a plist file and uploads all to AWS S3 | 
 <a href="/actions/notify/">notify</a> | Shows a macOS notification - use `notification` instead | ios, android, mac
 <a href="/actions/update_project_code_signing/">update_project_code_signing</a> | Updated code signing settings from 'Automatic' to a specific profile | ios
+<a href="/actions/xcode_install/">xcode_install</a> | Make sure a certain version of Xcode is installed | ios, mac
 <a href="/actions/ipa/">ipa</a> | Easily build and sign your app using shenzhen | ios
 <a href="/actions/upload_symbols_to_sentry/">upload_symbols_to_sentry</a> | Upload dSYM symbolication files to Sentry | ios
 <a href="/actions/opt_out_crash_reporting/">opt_out_crash_reporting</a> | This will prevent reports from being uploaded when _fastlane_ crashes | ios, android, mac

diff --git a/docs/generated/actions/build_app.md b/docs/generated/actions/build_app.md
@@ -87,7 +87,7 @@ That's all you need to build your application. If you want more control, here ar
 fastlane gym --workspace "Example.xcworkspace" --scheme "AppName" --clean
 ```
 
-If you need to use a different Xcode installation, use `xcode-select` or define `DEVELOPER_DIR`:
+If you need to use a different Xcode installation, use `[xcodes](https://docs.fastlane.tools/actions/xcodes)` or define `DEVELOPER_DIR`:
 
 ```no-highlight
 DEVELOPER_DIR="/Applications/Xcode6.2.app" fastlane gym
@@ -163,7 +163,7 @@ build_app(
   scheme: "Release",
   export_method: "app-store",
   export_options: {
-    provisioningProfiles: { 
+    provisioningProfiles: {
       "com.example.bundleid" => "Provisioning Profile Name",
       "com.example.bundleid2" => "Provisioning Profile Name 2"
     }
@@ -197,10 +197,10 @@ end
 error do |lane, exception|
   slack(
     # message with short human friendly message
-    message: exception.to_s, 
-    success: false, 
+    message: exception.to_s,
+    success: false,
     # Output containing extended log output
-    payload: { "Output" => exception.error_info.to_s } 
+    payload: { "Output" => exception.error_info.to_s }
   )
 end
 ```