Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bot] Update docs for latest fastlane release 2.190.0 (actions.md, available-plugins.md) 🚀 #1081

Merged
merged 1 commit into from
Aug 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
GIT
remote: https://github.com/fastlane/fastlane
revision: 3e60f1caea26698afef97619d381abb7accd4657
revision: 3b4186b94a91fff9b64674e3de2b669bb3970c31
specs:
fastlane (2.189.0)
fastlane (2.190.0)
CFPropertyList (>= 2.3, < 4.0.0)
addressable (>= 2.8, < 3.0.0)
artifactory (~> 3.0)
Expand Down Expand Up @@ -51,17 +51,17 @@ GEM
ast (2.4.2)
atomos (0.1.3)
aws-eventstream (1.1.1)
aws-partitions (1.480.0)
aws-sdk-core (3.117.0)
aws-partitions (1.482.0)
aws-sdk-core (3.119.0)
aws-eventstream (~> 1, >= 1.0.2)
aws-partitions (~> 1, >= 1.239.0)
aws-sigv4 (~> 1.1)
jmespath (~> 1.0)
aws-sdk-kms (1.44.0)
aws-sdk-core (~> 3, >= 3.112.0)
aws-sdk-kms (1.46.0)
aws-sdk-core (~> 3, >= 3.119.0)
aws-sigv4 (~> 1.1)
aws-sdk-s3 (1.96.2)
aws-sdk-core (~> 3, >= 3.112.0)
aws-sdk-s3 (1.98.0)
aws-sdk-core (~> 3, >= 3.119.0)
aws-sdk-kms (~> 1)
aws-sigv4 (~> 1.1)
aws-sigv4 (1.2.4)
Expand Down Expand Up @@ -99,14 +99,15 @@ GEM
dotenv (2.7.6)
emoji_regex (3.2.2)
excon (0.85.0)
faraday (1.5.1)
faraday (1.6.0)
faraday-em_http (~> 1.0)
faraday-em_synchrony (~> 1.0)
faraday-excon (~> 1.1)
faraday-httpclient (~> 1.0.1)
faraday-net_http (~> 1.0)
faraday-net_http_persistent (~> 1.1)
faraday-patron (~> 1.0)
faraday-rack (~> 1.0)
multipart-post (>= 1.2, < 3)
ruby2_keywords (>= 0.0.4)
faraday-cookie_jar (0.0.7)
Expand All @@ -121,13 +122,14 @@ GEM
faraday-net_http (1.0.1)
faraday-net_http_persistent (1.2.0)
faraday-patron (1.0.0)
faraday_middleware (1.0.0)
faraday-rack (1.0.0)
faraday_middleware (1.1.0)
faraday (~> 1.0)
fastimage (2.2.4)
gh_inspector (1.1.3)
git (1.9.1)
rchardet (~> 1.8)
google-apis-androidpublisher_v3 (0.9.0)
google-apis-androidpublisher_v3 (0.10.0)
google-apis-core (>= 0.4, < 2.a)
google-apis-core (0.4.1)
addressable (~> 2.5, >= 2.5.1)
Expand Down Expand Up @@ -158,7 +160,7 @@ GEM
google-cloud-core (~> 1.6)
googleauth (>= 0.16.2, < 2.a)
mini_mime (~> 1.0)
googleauth (0.16.2)
googleauth (0.17.0)
faraday (>= 0.17.3, < 2.0)
jwt (>= 1.4, < 3.0)
memoist (~> 0.16)
Expand Down
68 changes: 34 additions & 34 deletions docs/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,17 @@ Action | Description | Supported Platforms
<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/xcarchive/">xcarchive</a> | Archives the project using `xcodebuild` | ios, mac
<a href="/actions/build_app/">build_app</a> | Easily build and sign your app (via _gym_) | ios, mac
<a href="/actions/xcbuild/">xcbuild</a> | Builds 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/build_ios_app/">build_ios_app</a> | Alias for the `build_app` action but only for iOS | ios
<a href="/actions/xcbuild/">xcbuild</a> | Builds the project using `xcodebuild` | ios, mac
<a href="/actions/xctest/">xctest</a> | Runs tests on the given simulator | 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/xcexport/">xcexport</a> | Exports 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/spm/">spm</a> | Runs Swift Package Manager on your project | ios, android, mac
<a href="/actions/xcexport/">xcexport</a> | Exports the project using `xcodebuild` | ios, 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/xcarchive/">xcarchive</a> | Archives the project using `xcodebuild` | ios, mac
<a href="/actions/build_app/">build_app</a> | Easily build and sign your app (via _gym_) | 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/spm/">spm</a> | Runs Swift Package Manager on your project | ios, android, mac



Expand All @@ -101,9 +101,9 @@ Action | Description | Supported Platforms
<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_screenshots/">capture_screenshots</a> | Alias for the `capture_ios_screenshots` action | ios, mac
<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_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



Expand All @@ -126,8 +126,8 @@ Action | Description | Supported Platforms
<a href="/actions/update_url_schemes/">update_url_schemes</a> | Updates the URL schemes in the given Info.plist | ios, mac
<a href="/actions/set_build_number_repository/">set_build_number_repository</a> | Set the build number from the current repository | ios, mac
<a href="/actions/set_pod_key/">set_pod_key</a> | Sets a value for a key with cocoapods-keys | ios, mac
<a href="/actions/update_keychain_access_groups/">update_keychain_access_groups</a> | This action changes the keychain access groups in the entitlements file | ios
<a href="/actions/update_plist/">update_plist</a> | Update a plist file | ios
<a href="/actions/update_keychain_access_groups/">update_keychain_access_groups</a> | This action changes the keychain access groups in the entitlements file | ios



Expand All @@ -143,13 +143,13 @@ Action | Description | Supported Platforms
<a href="/actions/resign/">resign</a> | Codesign an existing ipa file | ios
<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/match_nuke/">match_nuke</a> | Easily nuke your certificate and provisioning profiles (via _match_) | ios, mac
<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/install_provisioning_profile/">install_provisioning_profile</a> | Install provisioning profile from path | 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/get_certificates/">get_certificates</a> | Create new iOS code signing certificates (via _cert_) | ios
<a href="/actions/update_code_signing_settings/">update_code_signing_settings</a> | Configures Xcode's Codesigning options | 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/install_provisioning_profile/">install_provisioning_profile</a> | Install provisioning profile from path | ios, mac



Expand Down Expand Up @@ -201,12 +201,12 @@ Action | Description | Supported Platforms
<a href="/actions/deliver/">deliver</a> | Alias for the `upload_to_app_store` action | ios, mac
<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_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
<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_from_play_store/">download_from_play_store</a> | Download metadata and binaries from Google Play (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/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/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



Expand Down Expand Up @@ -239,9 +239,9 @@ Action | Description | Supported Platforms
<a href="/actions/hg_push/">hg_push</a> | This will push changes to the remote hg repository | ios, android, mac
<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/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
<a href="/actions/git_remote_branch/">git_remote_branch</a> | Returns the name of the current git remote default branch | ios, android, mac



Expand Down Expand Up @@ -271,9 +271,9 @@ 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/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
<a href="/actions/create_app_online/">create_app_online</a> | Creates the given application on iTC and the Dev Portal (via _produce_) | ios



Expand Down Expand Up @@ -337,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/create_app_on_managed_play_store/">create_app_on_managed_play_store</a> | Create Managed Google Play Apps | 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/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_travis/">setup_travis</a> | Setup the keychain and match to work with Travis CI | ios, android, mac
<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/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/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/modify_services/">modify_services</a> | Modifies the services of the app created on Developer Portal | ios
<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/plugin_scores/">plugin_scores</a> | No description provided | ios, android, mac
<a href="/actions/println/">println</a> | Alias for the `puts` action | ios, android, mac
<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_release_names/">google_play_track_release_names</a> | Retrieves release names 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/spaceship_logs/">spaceship_logs</a> | Find, print, and copy Spaceship logs | 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/opt_out_usage/">opt_out_usage</a> | This will stop uploading the information which actions were run | ios, android, mac
<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/setup_travis/">setup_travis</a> | Setup the keychain and match to work with Travis CI | ios, android, mac
<a href="/actions/ruby_version/">ruby_version</a> | Verifies the minimum ruby version required | 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/setup_ci/">setup_ci</a> | Setup the keychain and match to work with CI | ios, 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/create_app_on_managed_play_store/">create_app_on_managed_play_store</a> | Create Managed Google Play Apps | android
<a href="/actions/min_fastlane_version/">min_fastlane_version</a> | Verifies the minimum fastlane version required | 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/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/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/google_play_track_version_codes/">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track | 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/google_play_track_release_names/">google_play_track_release_names</a> | Retrieves release names for a Google Play track | 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



Expand Down
2 changes: 1 addition & 1 deletion docs/actions/app_store_connect_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Key | Description | Default
`key_filepath` | The path to the key p8 file |
`key_content` | The content of the key p8 file |
`is_key_content_base64` | Whether :key_content is Base64 encoded or not | `false`
`duration` | The token session duration | `1200`
`duration` | The token session duration | `500`
`in_house` | Is App Store or Enterprise (in house) team? App Store Connect API cannot determine this on its own (yet) | `false`
`set_spaceship_token` | Authorizes all Spaceship::ConnectAPI requests by automatically setting Spaceship::ConnectAPI.token | `true`

Expand Down
4 changes: 2 additions & 2 deletions docs/actions/appstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ deliver(

## More options

<details>
<details markdown="1">
<summary>View all available options and their valid values</summary>

## Available options
Expand Down Expand Up @@ -527,7 +527,7 @@ Key | Editable While Live | Directory | Filename | Deprecated Filename

## Reference

<details>
<details markdown="1">
<summary>View all available categories, etc.</summary>

### Available Categories
Expand Down
2 changes: 2 additions & 0 deletions docs/actions/bundle_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Key | Description | Default
`trust_policy` | Sets level of security when dealing with signed gems. Accepts `LowSecurity`, `MediumSecurity` and `HighSecurity` as values |
`without` | Exclude gems that are part of the specified named group |
`with` | Include gems that are part of the specified named group |
`frozen` | Don't allow the Gemfile.lock to be updated after install | `false`
`redownload` | Force download every gem, even if the required versions are already available locally | `false`

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
4 changes: 2 additions & 2 deletions docs/actions/capture_android_screenshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ new CleanStatusBar()

# Advanced _screengrab_

<details>
<details markdown="1">
<summary>Launch Arguments</summary>

You can provide additional arguments to your test cases on launch. These strings will be available in your tests through `InstrumentationRegistry.getArguments()`.
Expand Down Expand Up @@ -290,7 +290,7 @@ if (extras != null) {
```
</details>

<details>
<details markdown="1">
<summary>Detecting screengrab at runtime</summary>

For some apps, it is helpful to know when _screengrab_ is running so that you can display specific data for your screenshots. For iOS fastlane users, this is much like "FASTLANE_SNAPSHOT". In order to do this, you'll need to have at least two product flavors of your app.
Expand Down
4 changes: 4 additions & 0 deletions docs/actions/clean_cocoapods_cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ clean_cocoapods_cache(name: "CACHED_POD")
Key | Description | Default
----|-------------|--------
`name` | Pod name to be removed from cache |
`no_ansi` | Show output without ANSI codes | `false`
`verbose` | Show more debugging information | `false`
`silent` | Show nothing | `false`
`allow_root` | Allows CocoaPods to run as root | `false`

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
Loading