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 (actions.md, available-plugins.md) 🚀 #754

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions Gemfile.lock
@@ -1,8 +1,8 @@
GIT
remote: https://github.com/fastlane/fastlane
revision: 9b74d258fbecd16ffa59be5021cf5c3ffeb4a8dd
revision: cd88359fa9b6772f91a31a290f8f3c790a716dc0
specs:
fastlane (2.108.0)
fastlane (2.109.1)
CFPropertyList (>= 2.3, < 4.0.0)
addressable (>= 2.3, < 3.0.0)
babosa (>= 1.0.2, < 2.0.0)
Expand Down Expand Up @@ -59,7 +59,7 @@ GEM
highline (~> 1.7.2)
cork (0.3.0)
colored2 (~> 3.1)
danger (5.7.1)
danger (5.9.0)
claide (~> 1.0)
claide-plugins (>= 0.9.2)
colored2 (~> 3.1)
Expand All @@ -78,7 +78,7 @@ GEM
dotenv (2.5.0)
emoji_regex (0.1.1)
excon (0.62.0)
faraday (0.15.3)
faraday (0.15.4)
multipart-post (>= 1.2, < 3)
faraday-cookie_jar (0.0.6)
faraday (>= 0.7.4)
Expand All @@ -87,7 +87,7 @@ GEM
faraday (~> 0.8)
faraday_middleware (0.12.2)
faraday (>= 0.7.4, < 1.0)
fastimage (2.1.4)
fastimage (2.1.5)
gh_inspector (1.1.3)
git (1.5.0)
google-api-client (0.23.9)
Expand Down Expand Up @@ -170,8 +170,8 @@ GEM
unicode-display_width (~> 1.1, >= 1.1.1)
tty-cursor (0.6.0)
tty-screen (0.6.5)
tty-spinner (0.8.0)
tty-cursor (>= 0.5.0)
tty-spinner (0.9.0)
tty-cursor (~> 0.6.0)
uber (0.1.0)
unf (0.1.4)
unf_ext
Expand Down
32 changes: 16 additions & 16 deletions docs/actions.md
Expand Up @@ -56,8 +56,8 @@ Action | Description | Supported Platforms
<a href="/actions/lcov/">lcov</a> | Generates coverage data using lcov | ios, mac
<a href="/actions/appium/">appium</a> | Run UI test by Appium with RSpec | ios, android
<a href="/actions/xctool/">xctool</a> | Run tests using xctool | ios, mac
<a href="/actions/xcode_server_get_assets/">xcode_server_get_assets</a> | Downloads Xcode Bot assets like the `.xcarchive` and logs | ios, mac
<a href="/actions/run_tests/">run_tests</a> | Easily run tests of your iOS app (via _scan_) | ios, mac
<a href="/actions/xcode_server_get_assets/">xcode_server_get_assets</a> | Downloads Xcode Bot assets like the `.xcarchive` and logs | ios, mac



Expand All @@ -79,15 +79,15 @@ 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/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_app/">build_app</a> | Alias for the `build_ios_app` action | ios, 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/xcarchive/">xcarchive</a> | Archives 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> | 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/xcarchive/">xcarchive</a> | Archives the project using `xcodebuild` | ios, mac
<a href="/actions/xcclean/">xcclean</a> | Cleans 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> | Alias for the `build_ios_app` action | ios, mac



Expand All @@ -98,10 +98,10 @@ 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, mac
<a href="/actions/frame_screenshots/">frame_screenshots</a> | Adds device frames around all screenshots (via _frameit_) | 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/capture_ios_screenshots/">capture_ios_screenshots</a> | Generate new localized screenshots on multiple devices (via _snapshot_) | ios, mac
<a href="/actions/frame_screenshots/">frame_screenshots</a> | Adds device frames around all screenshots (via _frameit_) | ios, mac
<a href="/actions/capture_screenshots/">capture_screenshots</a> | Alias for the `capture_ios_screenshots` action | ios, mac
<a href="/actions/capture_android_screenshots/">capture_android_screenshots</a> | Automated localized screenshots of your Android app (via _screengrab_) | android



Expand Down Expand Up @@ -141,9 +141,9 @@ 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/automatic_code_signing/">automatic_code_signing</a> | Configures Xcode's Codesigning options | 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
<a href="/actions/get_certificates/">get_certificates</a> | Create new iOS code signing certificates (via _cert_) | 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



Expand Down Expand Up @@ -196,9 +196,9 @@ 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_to_play_store/">upload_to_play_store</a> | Upload metadata, screenshots and binaries to Google Play (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



Expand Down Expand Up @@ -327,19 +327,19 @@ 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/plugin_scores/">plugin_scores</a> | No description provided | 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/min_fastlane_version/">min_fastlane_version</a> | Verifies the minimum fastlane version required | ios, android, mac
<a href="/actions/setup_circle_ci/">setup_circle_ci</a> | Setup the keychain and match to work with CircleCI | ios, 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/setup_travis/">setup_travis</a> | Setup the keychain and match to work with Travis CI | ios, mac
<a href="/actions/echo/">echo</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/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/opt_out_usage/">opt_out_usage</a> | This will stop uploading the information which actions were run | 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/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/create_app_on_managed_play_store/">create_app_on_managed_play_store</a> | Create Managed Google Play Apps | android
<a href="/actions/ruby_version/">ruby_version</a> | Verifies the minimum ruby version required | ios, android, mac
<a href="/actions/echo/">echo</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_version_codes/">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track | android



Expand Down
14 changes: 12 additions & 2 deletions docs/actions/appetize.md
Expand Up @@ -17,11 +17,11 @@ Upload your app to [Appetize.io](https://appetize.io/) to stream it in browser
appetize ||
---|---
Supported platforms | ios, android
Author | @klundberg, @giginet
Author | @klundberg, @giginet, @steprescott



## 1 Example
## 2 Examples

```ruby
appetize(
Expand All @@ -31,6 +31,15 @@ appetize(
)
```

```ruby
appetize(
path: "./MyApp.zip",
api_host: "company.appetize.io", # only needed for enterprise hosted solution
api_token: "yourapitoken", # get it from https://appetize.io/docs#request-api-token
public_key: "your_public_key" # get it from https://appetize.io/dashboard
)
```




Expand All @@ -39,6 +48,7 @@ appetize(

Key | Description | Default
----|-------------|--------
`api_host` | Appetize API host | `api.appetize.io`
`api_token` | Appetize.io API Token |
`url` | URL from which the ipa file can be fetched. Alternative to :path |
`platform` | Platform. Either `ios` or `android` | `ios`
Expand Down
21 changes: 12 additions & 9 deletions docs/actions/build_app.md
Expand Up @@ -147,25 +147,28 @@ export_options("./ExportOptions.plist")
or you can provide hash of values directly in the `Gymfile`:

```ruby-skip-tests
export_options = {
export_options({
method: "ad-hoc",
manifest: {
appURL: "https://example.com/My App.ipa",
},
thinning: "<thin-for-all-variants>"
}
})
```

Optional: If _gym_ can't automatically detect the provisioning profiles to use, you can pass a mapping of bundle identifiers to provisioning profiles:

```ruby-skip-tests
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
```ruby
build_ios_app(
scheme: "Release",
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
}
}
}
)
```

**Note**: If you use [_fastlane_](https://fastlane.tools) with [_match_](https://fastlane.tools/match) you don't need to provide those values manually.
Expand Down
21 changes: 12 additions & 9 deletions docs/actions/build_ios_app.md
Expand Up @@ -147,25 +147,28 @@ export_options("./ExportOptions.plist")
or you can provide hash of values directly in the `Gymfile`:

```ruby-skip-tests
export_options = {
export_options({
method: "ad-hoc",
manifest: {
appURL: "https://example.com/My App.ipa",
},
thinning: "<thin-for-all-variants>"
}
})
```

Optional: If _gym_ can't automatically detect the provisioning profiles to use, you can pass a mapping of bundle identifiers to provisioning profiles:

```ruby-skip-tests
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
```ruby
build_ios_app(
scheme: "Release",
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
}
}
}
)
```

**Note**: If you use [_fastlane_](https://fastlane.tools) with [_match_](https://fastlane.tools/match) you don't need to provide those values manually.
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/echo.md
Expand Up @@ -35,7 +35,7 @@ puts "Hi there"

Key | Description | Default
----|-------------|--------
`message` | Message to be printed out. Fastlane.swift only |
`message` | Message to be printed out |

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

Expand Down
21 changes: 12 additions & 9 deletions docs/actions/gym.md
Expand Up @@ -147,25 +147,28 @@ export_options("./ExportOptions.plist")
or you can provide hash of values directly in the `Gymfile`:

```ruby-skip-tests
export_options = {
export_options({
method: "ad-hoc",
manifest: {
appURL: "https://example.com/My App.ipa",
},
thinning: "<thin-for-all-variants>"
}
})
```

Optional: If _gym_ can't automatically detect the provisioning profiles to use, you can pass a mapping of bundle identifiers to provisioning profiles:

```ruby-skip-tests
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
```ruby
build_ios_app(
scheme: "Release",
export_options: {
method: "app-store",
provisioningProfiles: {
"com.example.bundleid" => "Provisioning Profile Name",
"com.example.bundleid2" => "Provisioning Profile Name 2"
}
}
}
)
```

**Note**: If you use [_fastlane_](https://fastlane.tools) with [_match_](https://fastlane.tools/match) you don't need to provide those values manually.
Expand Down
1 change: 1 addition & 0 deletions docs/actions/pod_lib_lint.md
Expand Up @@ -54,6 +54,7 @@ Key | Description | Default
`verbose` | Allow output detail in console |
`allow_warnings` | Allow warnings during pod lint |
`sources` | The sources of repos you want the pod spec to lint with, separated by commas |
`swift_version` | The SWIFT_VERSION that should be used to lint the spec. This takes precedence over a .swift-version file |
`use_libraries` | Lint uses static libraries to install the spec | `false`
`fail_fast` | Lint stops on the first failing platform or subspec | `false`
`private` | Lint skips checks that apply only to public specs | `false`
Expand Down
2 changes: 1 addition & 1 deletion docs/actions/println.md
Expand Up @@ -35,7 +35,7 @@ puts "Hi there"

Key | Description | Default
----|-------------|--------
`message` | Message to be printed out. Fastlane.swift only |
`message` | Message to be printed out |

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

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/puts.md
Expand Up @@ -35,7 +35,7 @@ puts "Hi there"

Key | Description | Default
----|-------------|--------
`message` | Message to be printed out. Fastlane.swift only |
`message` | Message to be printed out |

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

Expand Down
1 change: 1 addition & 0 deletions docs/actions/supply.md
Expand Up @@ -199,6 +199,7 @@ Key | Description | Default
`apk` | Path to the APK file to upload | [*](#parameters-legend-dynamic)
`apk_paths` | An array of paths to APK files to upload |
`aab` | Path to the AAB file to upload | [*](#parameters-legend-dynamic)
`aab_paths` | An array of paths to AAB files to upload |
`skip_upload_apk` | Whether to skip uploading APK | `false`
`skip_upload_aab` | Whether to skip uploading AAB | `false`
`skip_upload_metadata` | Whether to skip uploading metadata | `false`
Expand Down
1 change: 1 addition & 0 deletions docs/actions/testfairy.md
Expand Up @@ -50,6 +50,7 @@ Key | Description | Default
`auto_update` | Allows an easy upgrade of all users to the current version. To enable set to 'on' | `off`
`notify` | Send email to testers | `off`
`options` | Array of options (shake,video_only_wifi,anonymous) | `[]`
`timeout` | Request timeout in seconds |

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

Expand Down
1 change: 1 addition & 0 deletions docs/actions/upload_to_play_store.md
Expand Up @@ -199,6 +199,7 @@ Key | Description | Default
`apk` | Path to the APK file to upload | [*](#parameters-legend-dynamic)
`apk_paths` | An array of paths to APK files to upload |
`aab` | Path to the AAB file to upload | [*](#parameters-legend-dynamic)
`aab_paths` | An array of paths to AAB files to upload |
`skip_upload_apk` | Whether to skip uploading APK | `false`
`skip_upload_aab` | Whether to skip uploading AAB | `false`
`skip_upload_metadata` | Whether to skip uploading metadata | `false`
Expand Down