Browse files

Migrate remaining tool docs over to the new format (#10520)

* Add match docs

* Add docs for frameit

* Add pem docs

* Add pilot docs

* Add precheck docs

* Add docs for produce

* Add more docs of 3 more tools

* Add supply docs

* Add deprecation notes for cert docs

* Fix link to image

* Move into the right directory

* Deprecate ALL THE READMEs

* Simplify main README

* Reduce landing page

* Simplify

* Simplify more

* Italic font

* Remove header

* Improve design

* Remove twitter handle

* Update link to code signing guide

* Update all image references to use new paths

* Use `fastlane action [x]` instead of `fastlane [x] --help` in docs

* Fix tool spelling and add `no-highlight` to all the docs

* Replace all `:` based emojis with actual emojis
  • Loading branch information...
KrauseFx committed Oct 6, 2017
1 parent 9cfd849 commit 29e7788f3231ba913236f235c40b992e39866a6f
Showing with 7,710 additions and 4,538 deletions.
  1. +6 βˆ’161
  2. +7 βˆ’166 cert/
  3. +17 βˆ’281 deliver/
  4. +7 βˆ’287 deliver/
  5. +17 βˆ’162 deliver/
  6. +7 βˆ’209 fastlane/
  7. BIN fastlane/lib/fastlane/actions/docs/assets/FrameitGit.gif
  8. BIN fastlane/lib/fastlane/actions/docs/assets/MacExample.png
  9. BIN fastlane/lib/fastlane/actions/docs/assets/PEMRecording.gif
  10. BIN fastlane/lib/fastlane/actions/docs/assets/PilotTextTransparent.png
  11. BIN fastlane/lib/fastlane/actions/docs/assets/PilotTextTransparentSmall.png
  12. BIN fastlane/lib/fastlane/actions/docs/assets/PilotTextWhite.png
  13. BIN fastlane/lib/fastlane/actions/docs/assets/PilotTransparent.png
  14. BIN fastlane/lib/fastlane/actions/docs/assets/QuickLookScreenshot.png
  15. BIN fastlane/lib/fastlane/actions/docs/assets/ScreenshotsBig.png
  16. BIN fastlane/lib/fastlane/actions/docs/assets/ScreenshotsOverview.png
  17. BIN fastlane/lib/fastlane/actions/docs/assets/SignErrors.png
  18. BIN fastlane/lib/fastlane/actions/docs/assets/UDIDPrint.png
  19. BIN fastlane/lib/fastlane/actions/docs/assets/frameit.png
  20. BIN fastlane/lib/fastlane/actions/docs/assets/github_repo.png
  21. BIN fastlane/lib/fastlane/actions/docs/assets/htmlPage.png
  22. BIN fastlane/lib/fastlane/actions/docs/assets/htmlPagePreview.jpg
  23. BIN fastlane/lib/fastlane/actions/docs/assets/htmlPagePreviewFade.jpg
  24. BIN fastlane/lib/fastlane/actions/docs/assets/match.png
  25. BIN fastlane/lib/fastlane/actions/docs/assets/match_appstore_small.gif
  26. BIN fastlane/lib/fastlane/actions/docs/assets/match_init.gif
  27. BIN fastlane/lib/fastlane/actions/docs/assets/match_nuke.gif
  28. BIN fastlane/lib/fastlane/actions/docs/assets/pem.png
  29. +5,362 βˆ’0 fastlane/lib/fastlane/actions/docs/assets/
  30. BIN fastlane/lib/fastlane/actions/docs/assets/precheck.gif
  31. BIN fastlane/lib/fastlane/actions/docs/assets/precheck.png
  32. BIN fastlane/lib/fastlane/actions/docs/assets/produce.png
  33. BIN fastlane/lib/fastlane/actions/docs/assets/running-screengrab.gif
  34. BIN fastlane/lib/fastlane/actions/docs/assets/scan.png
  35. BIN fastlane/lib/fastlane/actions/docs/assets/scanHTML.png
  36. BIN fastlane/lib/fastlane/actions/docs/assets/scanHTMLFailing.png
  37. BIN fastlane/lib/fastlane/actions/docs/assets/scanScreenshot.png
  38. BIN fastlane/lib/fastlane/actions/docs/assets/screengrab.png
  39. BIN fastlane/lib/fastlane/actions/docs/assets/sigh.png
  40. BIN fastlane/lib/fastlane/actions/docs/assets/sighRecording.gif
  41. BIN fastlane/lib/fastlane/actions/docs/assets/slack.png
  42. BIN fastlane/lib/fastlane/actions/docs/assets/snapshot.gif
  43. BIN fastlane/lib/fastlane/actions/docs/assets/snapshot.png
  44. BIN fastlane/lib/fastlane/actions/docs/assets/supply.png
  45. BIN fastlane/lib/fastlane/actions/docs/assets/testSummary.png
  46. +2 βˆ’4 fastlane/lib/fastlane/actions/docs/
  47. +1 βˆ’3 fastlane/lib/fastlane/actions/docs/
  48. +215 βˆ’0 fastlane/lib/fastlane/actions/docs/
  49. +17 βˆ’17 fastlane/lib/fastlane/actions/docs/
  50. +352 βˆ’0 fastlane/lib/fastlane/actions/docs/
  51. +120 βˆ’0 fastlane/lib/fastlane/actions/docs/
  52. +218 βˆ’0 fastlane/lib/fastlane/actions/docs/
  53. +97 βˆ’0 fastlane/lib/fastlane/actions/docs/
  54. +227 βˆ’0 fastlane/lib/fastlane/actions/docs/
  55. +145 βˆ’0 fastlane/lib/fastlane/actions/docs/
  56. +145 βˆ’0 fastlane/lib/fastlane/actions/docs/
  57. +187 βˆ’0 fastlane/lib/fastlane/actions/docs/
  58. +333 βˆ’0 fastlane/lib/fastlane/actions/docs/
  59. +144 βˆ’0 fastlane/lib/fastlane/actions/docs/
  60. +7 βˆ’290 frameit/
  61. +7 βˆ’300 gym/
  62. +7 βˆ’420 match/
  63. +7 βˆ’188 pem/
  64. +7 βˆ’285 pilot/
  65. +7 βˆ’171 precheck/
  66. +7 βˆ’294 produce/
  67. +7 βˆ’219 scan/
  68. +7 βˆ’192 screengrab/
  69. +7 βˆ’262 sigh/
  70. +7 βˆ’408 snapshot/
  71. +7 βˆ’219 supply/
@@ -1,189 +1,34 @@
<h3 align="center">
<img src="fastlane/assets/fastlane_text.png" alt="fastlane Logo" />
<img src="fastlane/assets/fastlane_text.png" alt="fastlane Logo" width=500 />
[![Twitter: @FastlaneTools](](
[![Build Status](](
#### ✨ Check out []( on how to get started with fastlane ✨
`fastlane` is a tool for iOS and Android developers to automate tedious tasks like generating screenshots, dealing with provisioning profiles, and releasing your application.
Use a lane to define your process:
lane :beta do
sh "./"
Then to deploy a new 'beta' version of your app just run
`fastlane beta` :rocket:
| | fastlane |
:sparkles: | Connect iOS and Android build tools into one workflow (both _fastlane_ tools and third party tools)
:monorail: | Define different `deployment lanes` for App Store deployment, beta builds, or testing
:ship: | Deploy from any computer, including a CI server
:wrench: | Extend and customise functionality
:thought_balloon: | Never remember any difficult commands, just `fastlane`
:tophat: | Easy setup assistant to get started in a few minutes
:email: | Automatically pass on information from one build step to another (*e.g.* path to the `ipa` file)
:page_with_curl: | Store **everything** in Git. Never lookup build commands on your CI system again.
:rocket: | Saves you **hours** for every app update you release
:pencil2: | Flexible configuration using a fully customisable `Fastfile`
:mountain_cableway: | Implement a fully working Continuous Delivery process
:ghost: | [Jenkins Integration]( Show output directly in test results
:book: | Automatically generate Markdown documentation of your lane configurations
:hatching_chick: | Over 170 built-in integrations and 170 plugins available
:computer: | Support for iOS and Android apps
:octocat: | Full Git and Mercurial support
<hr />
<h4 align="center">
Check out the new <a href="">fastlane docs</a>
<hr />
##### Like this tool? [Be the first to know about updates and new fastlane tools](
## Installation
Make sure you have the latest version of the Xcode command line tools installed:
xcode-select --install
### Choose your installation method:
<table width="100%" >
<th width="33%"><a href="">Homebrew</a></td>
<th width="33%">Installer Script</td>
<th width="33%">Rubygems</td>
<td width="33%" align="center">macOS</td>
<td width="33%" align="center">macOS</td>
<td width="33%" align="center">macOS or Linux with Ruby 2.0.0 or above</td>
<td width="33%"><code>brew cask install fastlane</code></td>
<td width="33%"><a href="">Download the zip file</a>. Then double click on the <code>install</code> script (or run it in a terminal window).</td>
<td width="33%"><code>sudo gem install fastlane -NV</code></td>
## Quick Start
Get started distributing your first app with fastlane within minutes:
[Create your first Fastfile](
Want to learn more? Explore guides for [iOS](
or [Android](
## System Requirements
Currently, _fastlane_ is officially supported to run on macOS. Support for other operating systems is limited and untested at this point in time. _fastlane_ uses system APIs that may not be implemented on other platforms, for example, we use the Ruby `fork` method for sub-process management, which isn't available on Windows.
## Available Commands
Typically you'll use `fastlane` by triggering individual lanes:
fastlane [lane_name]
#### Other Commands
- `fastlane actions`: List all available `fastlane` actions
- `fastlane action [action_name]`: Shows a more detailed description of an action
- `fastlane lanes`: Lists all available lanes with description
- `fastlane list`: Lists all available lanes without description
- `fastlane new_action`: Create a new action *(integration)* for fastlane
- `fastlane env`: Print out the fastlane ruby environment when submitting an issue
If you'd like to take a look at a project already using `fastlane` check out [fastlane-examples]( which includes `fastlane` setups by Wikipedia, Product Hunt, MindNode, and more.
<hr />
<h4 align="center">
Check out the new <a href="">fastlane docs</a>
<h2 align="center">
✨ All fastlane docs were moved to <a href=""></a> ✨
<hr />
## [`fastlane`]( Toolchain
In addition to `fastlane`'s commands, you also have access to these `fastlane` tools:
- [`deliver`]( Upload screenshots, metadata, and your app to the App Store
- [`supply`]( Upload your Android app and its metadata to Google Play
- [`snapshot`]( Automate taking localized screenshots of your iOS and tvOS apps on every device
- [`screengrab`]( Automate taking localized screenshots of your Android app on every device
- [`frameit`]( Quickly put your screenshots into the right device frames
- [`pem`]( Automatically generate and renew your push notification profiles
- [`sigh`]( Because you would rather spend your time building stuff than fighting provisioning
- [`produce`]( Create new iOS apps on iTunes Connect and Dev Portal using the command line
- [`cert`]( Automatically create and maintain iOS code signing certificates
- [`spaceship`]( Ruby library to access the Apple Dev Center and iTunes Connect
- [`pilot`]( The best way to manage your TestFlight testers and builds from your terminal
- [`boarding`]( The easiest way to invite your TestFlight beta testers
- [`gym`]( Building your iOS apps has never been easier
- [`match`]( Easily sync your certificates and profiles across your team using Git
- [`scan`]( The easiest way to run tests for your iOS and Mac apps
- [`precheck`]( Check your app using a community driven set of App Store review rules to avoid being rejected
## Metrics
_fastlane_ tracks a few key metrics to understand how developers are using the tool and to help us know what areas need improvement. No personal/sensitive information is ever collected. Metrics that are collected include:
* The number of successes, errors, and crashes for _fastlane_ and each action run in a Fastfile
* The running time of _fastlane_
* The method by which _fastlane_ was installed
* Whether _fastlane_ is being run on CI
* The platform (e.g. iOS, Android) for which _fastlane_ is run
* A hash of the app identifier or package name, which helps us anonymously identify unique usage of _fastlane_
We have recently changed the destination service to which these metrics are reported, as well as the format of the data, but the data that is collected has not changed.
You can easily opt-out of metrics collection by adding `opt_out_usage` at the top of your `Fastfile` or by setting the environment variable `FASTLANE_OPT_OUT_USAGE`. Participating helps us provide the best possible support for _fastlane_, so we hope you'll consider it a plus! :heavy_plus_sign:
## Crash Reporting
In order to continuously improve stability, _fastlane_ will record crash reports with sanitized stack traces. Sanitization removes personal information from the stack trace and error message (including home directories, _fastlane_ path, gem paths, environment variables, and parameters).
You can easily opt-out of crash reporting by adding `opt_out_crash_reporting` at the top of your `Fastfile` or by setting the environment variable `FASTLANE_OPT_OUT_CRASH_REPORTING`. Just like metrics mentioned above, participating helps us provide the best possible support for _fastlane_, so we hope you'll consider it a plus! :heavy_plus_sign:
## Need Help?
Before submitting a new GitHub issue, please make sure to
- Check out [](
- Check out the README pages on [this repo](
- Search for [existing GitHub issues](
If the above doesn't help, please [submit an issue]( on GitHub and provide information about your setup, in particular the output of the `fastlane env` command.
**Note**: If you want to report a regression in _fastlane_ (something that has worked before, but broke with a new release), please mark your issue title as such using `[Regression] Your title here`. This enables us to quickly detect and fix regressions.
## Special Thanks
Thanks to all [contributors]( for extending and improving `fastlane`.
## Speakers
## Contribute to _fastlane_
Are you giving a talk on fastlane? Great! [Let us know]( so we can help you give the best possible presentation.
Check out []( for more information on how to help with _fastlane_.
## Code of Conduct
Oops, something went wrong.

0 comments on commit 29e7788

Please sign in to comment.