Skip to content

Commit fa6fb60

Browse files
author
Mark Pirri
committed
Update docs for latest fastlane release (actions.md, available-plugins.md) 🚀
1 parent 0890482 commit fa6fb60

24 files changed

+4207
-1670
lines changed

Gemfile.lock

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
GIT
22
remote: https://github.com/fastlane/fastlane
3-
revision: 98dd765bbb9ede109e8fc35c0f5221f94a8bc8b5
3+
revision: 0e70799ef0149c6de1717098961183d3a7f7c839
44
specs:
5-
fastlane (2.68.2)
5+
fastlane (2.70.2)
66
CFPropertyList (>= 2.3, < 3.0.0)
77
addressable (>= 2.3, < 3.0.0)
88
babosa (>= 1.0.2, < 2.0.0)
@@ -30,7 +30,7 @@ GIT
3030
slack-notifier (>= 1.3, < 2.0.0)
3131
terminal-notifier (>= 1.6.2, < 2.0.0)
3232
terminal-table (>= 1.4.5, < 2.0.0)
33-
tty-screen (~> 0.6.2)
33+
tty-screen (~> 0.6.3)
3434
word_wrap (~> 1.0.0)
3535
xcodeproj (>= 1.5.2, < 2.0.0)
3636
xcpretty (>= 0.2.4, < 1.0.0)
@@ -39,7 +39,7 @@ GIT
3939
GEM
4040
remote: https://rubygems.org/
4141
specs:
42-
CFPropertyList (2.3.5)
42+
CFPropertyList (2.3.6)
4343
addressable (2.5.2)
4444
public_suffix (>= 2.0.2, < 4.0)
4545
babosa (1.0.2)
@@ -71,7 +71,7 @@ GEM
7171
domain_name (0.5.20170404)
7272
unf (>= 0.0.5, < 1.0.0)
7373
dotenv (2.2.1)
74-
excon (0.59.0)
74+
excon (0.60.0)
7575
faraday (0.13.1)
7676
multipart-post (>= 1.2, < 3)
7777
faraday-cookie_jar (0.0.6)
@@ -81,7 +81,7 @@ GEM
8181
faraday (~> 0.8)
8282
faraday_middleware (0.12.2)
8383
faraday (>= 0.7.4, < 1.0)
84-
fastimage (2.1.0)
84+
fastimage (2.1.1)
8585
gh_inspector (1.0.3)
8686
git (1.3.0)
8787
google-api-client (0.13.6)
@@ -121,11 +121,11 @@ GEM
121121
nanaimo (0.2.3)
122122
nap (1.1.0)
123123
no_proxy_fix (0.1.2)
124-
octokit (4.7.0)
124+
octokit (4.8.0)
125125
sawyer (~> 0.8.0, >= 0.5.3)
126126
open4 (1.3.4)
127127
os (0.9.6)
128-
plist (3.3.0)
128+
plist (3.4.0)
129129
public_suffix (2.0.5)
130130
representable (3.0.4)
131131
declarative (< 0.1.0)
@@ -154,7 +154,7 @@ GEM
154154
unf_ext (0.0.7.4)
155155
unicode-display_width (1.3.0)
156156
word_wrap (1.0.0)
157-
xcodeproj (1.5.3)
157+
xcodeproj (1.5.4)
158158
CFPropertyList (~> 2.3.3)
159159
claide (>= 1.0.2, < 2.0)
160160
colored2 (~> 3.1)

docs/actions.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Action | Description
5252
<a href="/actions/lcov">lcov</a> | Generates coverage data using lcov
5353
<a href="/actions/appium">appium</a> | Run UI test by Appium with RSpec
5454
<a href="/actions/xctool">xctool</a> | Run tests using xctool
55-
<a href="/actions/run_tests">run_tests</a> | Easily run tests of your iOS app (via _scan_)
5655
<a href="/actions/xcode_server_get_assets">xcode_server_get_assets</a> | Downloads Xcode Bot assets like the `.xcarchive` and logs
56+
<a href="/actions/run_tests">run_tests</a> | Easily run tests of your iOS app (via _scan_)
5757

5858

5959

@@ -75,14 +75,14 @@ Action | Description
7575
<a href="/actions/verify_xcode">verify_xcode</a> | Verifies that the Xcode installation is properly signed by Apple
7676
<a href="/actions/xcode_install">xcode_install</a> | Make sure a certain version of Xcode is installed
7777
<a href="/actions/verify_pod_keys">verify_pod_keys</a> | Verifies all keys referenced from the Podfile are non-empty
78-
<a href="/actions/xcbuild">xcbuild</a> | Builds the project using `xcodebuild`
78+
<a href="/actions/build_android_app">build_android_app</a> | Alias for the `gradle` action
79+
<a href="/actions/build_app">build_app</a> | Alias for the `build_ios_app` action
80+
<a href="/actions/xcclean">xcclean</a> | Cleans the project using `xcodebuild`
7981
<a href="/actions/xctest">xctest</a> | Runs tests on the given simulator
8082
<a href="/actions/xcarchive">xcarchive</a> | Archives the project using `xcodebuild`
83+
<a href="/actions/xcbuild">xcbuild</a> | Builds the project using `xcodebuild`
8184
<a href="/actions/xcexport">xcexport</a> | Exports the project using `xcodebuild`
8285
<a href="/actions/build_ios_app">build_ios_app</a> | Easily build and sign your app (via _gym_)
83-
<a href="/actions/build_android_app">build_android_app</a> | Alias for the `gradle` action
84-
<a href="/actions/build_app">build_app</a> | Alias for the `build_ios_app` action
85-
<a href="/actions/xcclean">xcclean</a> | Cleans the project using `xcodebuild`
8686

8787

8888

@@ -93,10 +93,10 @@ Action | Description
9393
<a href="/actions/snapshot">snapshot</a> | Alias for the `capture_ios_screenshots` action
9494
<a href="/actions/screengrab">screengrab</a> | Alias for the `capture_android_screenshots` action
9595
<a href="/actions/frameit">frameit</a> | Alias for the `frame_screenshots` action
96-
<a href="/actions/capture_screenshots">capture_screenshots</a> | Alias for the `capture_ios_screenshots` action
97-
<a href="/actions/frame_screenshots">frame_screenshots</a> | Adds device frames around all screenshots (via _frameit_)
9896
<a href="/actions/capture_android_screenshots">capture_android_screenshots</a> | Automated localized screenshots of your Android app (via _screengrab_)
9997
<a href="/actions/capture_ios_screenshots">capture_ios_screenshots</a> | Generate new localized screenshots on multiple devices (via _snapshot_)
98+
<a href="/actions/capture_screenshots">capture_screenshots</a> | Alias for the `capture_ios_screenshots` action
99+
<a href="/actions/frame_screenshots">frame_screenshots</a> | Adds device frames around all screenshots (via _frameit_)
100100

101101

102102

@@ -135,8 +135,8 @@ Action | Description
135135
<a href="/actions/register_devices">register_devices</a> | Registers new devices to the Apple Dev Portal
136136
<a href="/actions/automatic_code_signing">automatic_code_signing</a> | Updates the Xcode 8 Automatic Codesigning Flag
137137
<a href="/actions/register_device">register_device</a> | Registers a new device to the Apple Dev Portal
138-
<a href="/actions/sync_code_signing">sync_code_signing</a> | Easily sync your certificates and profiles across your team (via _match_)
139138
<a href="/actions/get_certificates">get_certificates</a> | Create new iOS code signing certificates (via _cert_)
139+
<a href="/actions/sync_code_signing">sync_code_signing</a> | Easily sync your certificates and profiles across your team (via _match_)
140140
<a href="/actions/get_provisioning_profile">get_provisioning_profile</a> | Generates a provisioning profile, saving it in the current folder (via _sigh_)
141141

142142

@@ -251,7 +251,7 @@ Action | Description
251251
---|---
252252
<a href="/actions/puts">puts</a> | Prints out the given text
253253
<a href="/actions/default_platform">default_platform</a> | Defines a default platform to not have to specify the platform
254-
<a href="/actions/fastlane_version">fastlane_version</a> | Verifies the minimum fastlane version required
254+
<a href="/actions/fastlane_version">fastlane_version</a> | Alias for the `min_fastlane_version` action
255255
<a href="/actions/lane_context">lane_context</a> | An alias to `Actions.lane_context`
256256
<a href="/actions/import">import</a> | Import another Fastfile to use its lanes
257257
<a href="/actions/import_from_git">import_from_git</a> | Import another Fastfile from a remote git repository to use its lanes
@@ -310,16 +310,18 @@ Action | Description
310310
<a href="/actions/build_and_upload_to_appetize">build_and_upload_to_appetize</a> | Generate and upload an ipa file to appetize.io
311311
<a href="/actions/update_icloud_container_identifiers">update_icloud_container_identifiers</a> | This action changes the iCloud container identifiers in the entitlements file
312312
<a href="/actions/sh">sh</a> | Runs a shell command
313-
<a href="/actions/opt_out_crash_reporting">opt_out_crash_reporting</a> | This will prevent reports from being uploaded when _fastlane_ crashes
314-
<a href="/actions/plugin_scores">plugin_scores</a> | No description provided
313+
<a href="/actions/google_play_track_version_codes">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track
315314
<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_)
316-
<a href="/actions/modify_services">modify_services</a> | Modifies the services of the app created on Developer Portal
317-
<a href="/actions/opt_out_usage">opt_out_usage</a> | This will stop uploading the information which actions were run
315+
<a href="/actions/setup_travis">setup_travis</a> | Setup the keychain and match to work with Travis CI
316+
<a href="/actions/opt_out_crash_reporting">opt_out_crash_reporting</a> | This will prevent reports from being uploaded when _fastlane_ crashes
317+
<a href="/actions/create_app_online">create_app_online</a> | Creates the given application on iTC and the Dev Portal (via _produce_)
318318
<a href="/actions/ruby_version">ruby_version</a> | Verifies the minimum ruby version required
319-
<a href="/actions/google_play_track_version_codes">google_play_track_version_codes</a> | Retrieves version codes for a Google Play track
319+
<a href="/actions/environment_variable">environment_variable</a> | Sets/gets env vars for Fastlane.swift. Don't use in ruby, use `ENV[key] = val`
320+
<a href="/actions/min_fastlane_version">min_fastlane_version</a> | Verifies the minimum fastlane version required
321+
<a href="/actions/opt_out_usage">opt_out_usage</a> | This will stop uploading the information which actions were run
320322
<a href="/actions/setup_circle_ci">setup_circle_ci</a> | Setup the keychain and match to work with CircleCI
321-
<a href="/actions/create_app_online">create_app_online</a> | Creates the given application on iTC and the Dev Portal (via _produce_)
322-
<a href="/actions/setup_travis">setup_travis</a> | Setup the keychain and match to work with Travis CI
323+
<a href="/actions/plugin_scores">plugin_scores</a> | [31mNo description provided[0m
324+
<a href="/actions/modify_services">modify_services</a> | Modifies the services of the app created on Developer Portal
323325

324326

325327

docs/actions/appledoc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Key | Description
6161
`create_docset` | Create documentation set
6262
`install_docset` | Install documentation set to Xcode
6363
`publish_docset` | Prepare DocSet for publishing
64+
`no_create_docset` | Create HTML and skip creating a DocSet
6465
`html_anchors` | The html anchor format to use in DocSet HTML
6566
`clean_output` | Remove contents of output path before starting
6667
`docset_bundle_id` | DocSet bundle identifier

docs/actions/build_app.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ build_ios_app(
3737
clean: true,
3838
output_directory: "path/to/dir", # Destination directory. Defaults to current directory.
3939
output_name: "my-app.ipa", # specify the name of the .ipa file to generate (including file extension)
40-
sdk: "10.0" # use SDK as the name or path of the base SDK when building the project.
40+
sdk: "iOS 11.1" # use SDK as the name or path of the base SDK when building the project.
4141
)
4242
```
4343

@@ -73,6 +73,7 @@ Key | Description
7373
`export_options` | Specifies path to export options plist. Use 'xcodebuild -help' to print the full set of available options
7474
`export_xcargs` | Pass additional arguments to xcodebuild for the package phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS="-ObjC -lstdc++"
7575
`skip_build_archive` | Export ipa from previously built xarchive. Uses archive_path as source
76+
`skip_archive` | After building, don't archive, effectively not including -archivePath param
7677
`build_path` | The directory in which the archive should be stored in
7778
`archive_path` | The path to the created archive
7879
`derived_data_path` | The directory where built products and other derived data will go

docs/actions/build_ios_app.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ build_ios_app(
3737
clean: true,
3838
output_directory: "path/to/dir", # Destination directory. Defaults to current directory.
3939
output_name: "my-app.ipa", # specify the name of the .ipa file to generate (including file extension)
40-
sdk: "10.0" # use SDK as the name or path of the base SDK when building the project.
40+
sdk: "iOS 11.1" # use SDK as the name or path of the base SDK when building the project.
4141
)
4242
```
4343

@@ -73,6 +73,7 @@ Key | Description
7373
`export_options` | Specifies path to export options plist. Use 'xcodebuild -help' to print the full set of available options
7474
`export_xcargs` | Pass additional arguments to xcodebuild for the package phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS="-ObjC -lstdc++"
7575
`skip_build_archive` | Export ipa from previously built xarchive. Uses archive_path as source
76+
`skip_archive` | After building, don't archive, effectively not including -archivePath param
7677
`build_path` | The directory in which the archive should be stored in
7778
`archive_path` | The path to the created archive
7879
`derived_data_path` | The directory where built products and other derived data will go

docs/actions/create_app_online.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Key | Description
5959
`skip_itc` | Skip the creation of the app on iTunes Connect
6060
`itc_users` | Array of iTunes Connect users. If provided, you can limit access to this newly created app for users with the App Manager, Developer, Marketer or Sales roles
6161
`enabled_features` | [DEPRECATED!] Please use `enable_services` instead - Array with Spaceship App Services
62-
`enable_services` | Array with Spaceship App Services (e.g. app_group: (on|off), apple_pay: (on|off), associated_domains: (on|off), data_protection: (complete|unlessopen|untilfirstauth), game_center: (on|off), health_kit: (on|off), home_kit: (on|off), wireless_accessory: (on|off), icloud: (legacy|cloudkit), in_app_purchase: (on|off), inter_app_audio: (on|off), passbook: (on|off), push_notification: (on|off), siri_kit: (on|off), vpn_configuration: (on|off))
62+
`enable_services` | Array with Spaceship App Services (e.g. app_group: (on|off), apple_pay: (on|off), associated_domains: (on|off), data_protection: (complete|unlessopen|untilfirstauth), game_center: (on|off), health_kit: (on|off), home_kit: (on|off), wireless_accessory: (on|off), icloud: (legacy|cloudkit), in_app_purchase: (on|off), inter_app_audio: (on|off), passbook: (on|off), push_notification: (on|off), siri_kit: (on|off), vpn_configuration: (on|off), network_extension: (on|off), hotspot: (on|off), multipath: (on|off), nfc_tag_reading: (on|off))
6363
`skip_devcenter` | Skip the creation of the app on the Apple Developer Portal
6464
`team_id` | The ID of your Developer Portal team if you're in multiple teams
6565
`team_name` | The name of your Developer Portal team if you're in multiple teams

docs/actions/danger.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Key | Description
5454
`new_comment` | Makes Danger post a new comment instead of editing its previous one
5555
`base` | A branch/tag/commit to use as the base of the diff. [master|dev|stable]
5656
`head` | A branch/tag/commit to use as the head. [master|dev|stable]
57+
`pr` | Run danger on a specific pull request. e.g. "https://github.com/danger/danger/pull/518"
5758

5859

5960

docs/actions/download_dsyms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Key | Description
5151
`app_identifier` | The bundle identifier of your app
5252
`team_id` | The ID of your iTunes Connect team if you're in multiple teams
5353
`team_name` | The name of your iTunes Connect team if you're in multiple teams
54-
`platform` | The app platform for dSYMs you wish to download
54+
`platform` | The app platform for dSYMs you wish to download (ios, appletvos)
5555
`version` | The app version for dSYMs you wish to download, pass in 'latest' to download only the latest build's dSYMs
5656
`build_number` | The app build_number for dSYMs you wish to download
5757
`output_directory` | Where to save the download dSYMs, defaults to the current path

docs/actions/environment_variable.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!--
2+
This file is auto-generated and will be re-generated every time the docs are updated.
3+
To modify it, go to its source at https://github.com/fastlane/fastlane.
4+
-->
5+
6+
# environment_variable
7+
8+
9+
Sets/gets env vars for Fastlane.swift. Don't use in ruby, use `ENV[key] = val`
10+
11+
12+
13+
14+
15+
16+
17+
environment_variable |
18+
-----|----
19+
Supported platforms | ios, android, mac
20+
Author | @taquitos
21+
22+
23+
24+
25+
26+
## Parameters
27+
28+
Key | Description
29+
----|------------
30+
`set` | Set the environment variables named
31+
`get` | Get the environment variable named
32+
`remove` | Remove the environment variable named
33+
34+
35+
36+
37+
<hr />
38+
To show the documentation in your terminal, run
39+
```no-highlight
40+
fastlane action environment_variable
41+
```
42+
43+
<a href="https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/environment_variable.rb" target="_blank">View source code</a>
44+
45+
<hr />
46+
47+
<a href="/actions"><b>Back to actions</b></a>

docs/actions/fastlane_version.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ To modify it, go to its source at https://github.com/fastlane/fastlane.
66
# fastlane_version
77

88

9-
Verifies the minimum fastlane version required
9+
Alias for the `min_fastlane_version` action
1010

1111

1212

1313

1414
> Add this to your `Fastfile` to require a certain version of _fastlane_.
15-
Use it if you use an action that just recently came out and you need it
15+
Use it if you use an action that just recently came out and you need it.
1616

1717

1818
fastlane_version |
@@ -25,7 +25,7 @@ Author | @KrauseFx
2525
## 1 Example
2626

2727
```ruby
28-
fastlane_version "1.50.0"
28+
min_fastlane_version "1.50.0"
2929
```
3030

3131

0 commit comments

Comments
 (0)