fastlane_iac_publish 0.1.0

data/fastlane/lib/fastlane/actions/docs/get_certificates.md

@@ -0,0 +1,86 @@
+<p align="center">
+  <img src="/img/actions/cert.png" width="250">
+</p>
+
+-------
+<p align="center">
+    <a href="#why">Why?</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a> &bull;
+    <a href="#tips">Tips</a>
+</p>
+
+-------
+
+<h5 align="center"><em>cert</em> is part of <a href="https://fastlane.tools">fastlane</a>: The easiest way to automate beta deployments and releases for your iOS and Android apps.</h5>
+
+![/img/actions/cert.gif](/img/actions/cert.gif)
+
+In the gif we used `cert && sigh`, which will first create an iOS code signing certificate and then a provisioning profile for your app if _cert_ succeeded.
+
+# Usage
+
+**Note**: It is recommended to use [_match_](/actions/match/) according to the [codesigning.guide](https://codesigning.guide) for generating and maintaining your certificates. Use _cert_ directly only if you want full control over what's going on and know more about codesigning.
+
+```no-highlight
+fastlane cert
+```
+
+This will check if any of the available signing certificates is installed on your local machine.
+
+Only if a new certificate needs to be created, _cert_ will
+
+- Create a new private key
+- Create a new signing request
+- Generate, downloads and installs the certificate
+- Import all the generated files into your Keychain
+
+_cert_ will never revoke your existing certificates. If you can't create any more certificates, _cert_ will raise an exception, which means, you have to revoke one of the existing certificates to make room for a new one.
+
+
+You can pass your Apple ID:
+
+```no-highlight
+fastlane cert -u cert@krausefx.com
+```
+
+For a list of available commands run
+
+```no-highlight
+fastlane action cert
+```
+
+Keep in mind, there is no way for _cert_ to download existing certificates + private keys from the Apple Developer Portal, as the private key never leaves your computer.
+
+## Environment Variables
+
+Run `fastlane action cert` to get a list of all available environment variables.
+
+## Use with [_sigh_](https://docs.fastlane.tools/actions/sigh/)
+
+_cert_ becomes really interesting when used in [_fastlane_](https://fastlane.tools) in combination with [_sigh_](https://docs.fastlane.tools/actions/sigh/).
+
+Update your `Fastfile` to contain the following code:
+
+```ruby
+lane :beta do
+  cert
+  sigh(force: true)
+end
+```
+
+`force: true` will make sure to re-generate the provisioning profile on each run.
+This will result in _sigh_ always using the correct signing certificate, which is installed on the local machine.
+
+
+## How is my password stored?
+_cert_ uses the [password manager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from _fastlane_. Take a look the [CredentialsManager README](https://github.com/fastlane/fastlane/blob/master/credentials_manager/README.md) for more information.
+
+# Tips
+
+## Use 'ProvisionQL' for advanced Quick Look in Finder
+
+Install [ProvisionQL](https://github.com/ealeksandrov/ProvisionQL).
+
+It will show you `mobileprovision` files like this:
+![img/actions/QuickLookScreenshot-Provision.png](/img/actions/QuickLookScreenshot-Provision.png)

data/fastlane/lib/fastlane/actions/docs/get_provisioning_profile.md

@@ -0,0 +1,223 @@
+<p align="center">
+  <img src="/img/actions/sigh.png" width="250">
+</p>
+
+###### Because you would rather spend your time building stuff than fighting provisioning
+
+_sigh_ can create, renew, download and repair provisioning profiles (with one command). It supports App Store, Ad Hoc, Development and Enterprise profiles and supports nice features, like auto-adding all test devices.
+
+-------
+
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#resign">Resign</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a>
+</p>
+
+-------
+
+# Features
+
+- **Download** the latest provisioning profile for your app
+- **Renew** a provisioning profile, when it has expired
+- **Repair** a provisioning profile, when it is broken
+- **Create** a new provisioning profile, if it doesn't exist already
+- Supports **App Store**, **Ad Hoc** and **Development** profiles
+- Support for **multiple Apple accounts**, storing your credentials securely in the Keychain
+- Support for **multiple Teams**
+- Support for **Enterprise Profiles**
+
+To automate iOS Push profiles you can use [_pem_](https://docs.fastlane.tools/actions/pem/).
+
+
+### Why not let Xcode do the work?
+
+- _sigh_ can easily be integrated into your CI-server (e.g. Jenkins)
+- Xcode sometimes invalidates [all existing profiles](/img/actions/SignErrors.png)
+- You have control over what happens
+- You still get to have the signing files, which you can then use for your build scripts or store in git
+
+See _sigh_ in action:
+
+![img/actions/sighRecording.gif](/img/actions/sighRecording.gif)
+
+# Usage
+
+**Note**: It is recommended to use [_match_](https://docs.fastlane.tools/actions/match/) according to the [codesigning.guide](https://codesigning.guide) for generating and maintaining your provisioning profiles. Use _sigh_ directly only if you want full control over what's going on and know more about codesigning.
+
+```no-highlight
+fastlane sigh
+```
+
+Yes, that's the whole command!
+
+_sigh_ will create, repair and download profiles for the App Store by default.
+
+You can pass your bundle identifier and username like this:
+
+```no-highlight
+fastlane sigh -a com.krausefx.app -u username
+```
+
+If you want to generate an **Ad Hoc** profile instead of an App Store profile:
+
+```no-highlight
+fastlane sigh --adhoc
+```
+
+If you want to generate a **Development** profile:
+
+```no-highlight
+fastlane sigh --development
+```
+
+To generate the profile in a specific directory:
+
+```no-highlight
+fastlane sigh -o "~/Certificates/"
+```
+
+To download all your provisioning profiles use
+
+```no-highlight
+fastlane sigh download_all
+```
+
+Optionally, use `fastlane sigh download_all --download_xcode_profiles` to also include the Xcode managed provisioning profiles
+
+For a list of available parameters and commands run
+
+```no-highlight
+fastlane action sigh
+```
+
+### Advanced
+
+By default, _sigh_ will install the downloaded profile on your machine. If you just want to generate the profile and skip the installation, use the following flag:
+
+```no-highlight
+fastlane sigh --skip_install
+```
+
+To save the provisioning profile under a specific name, use the -q option:
+
+```no-highlight
+fastlane sigh -a com.krausefx.app -u username -q "myProfile.mobileprovision"
+```
+
+If for some reason you don't want _sigh_ to verify that the code signing identity is installed on your local machine:
+
+```no-highlight
+fastlane sigh --skip_certificate_verification
+```
+
+If you need the provisioning profile to be renewed regardless of its state use the `--force` option. This gives you a profile with the maximum lifetime. `--force` will also add all available devices to this profile.
+
+```no-highlight
+fastlane sigh --force
+```
+
+By default, _sigh_ will include all certificates on development profiles, and first certificate on other types. If you need to specify which certificate to use you can either use the environment variable `SIGH_CERTIFICATE`, or pass the name or expiry date of the certificate as argument:
+
+```no-highlight
+fastlane sigh -c "SunApps GmbH"
+```
+
+For a list of available parameters and commands run
+
+```no-highlight
+fastlane action sigh
+```
+
+
+### Use with [_fastlane_](https://fastlane.tools)
+
+_sigh_ becomes really interesting when used in [_fastlane_](https://fastlane.tools) in combination with [_cert_](https://docs.fastlane.tools/actions/cert/).
+
+Update your `Fastfile` to contain the following code:
+
+```ruby
+lane :beta do
+  cert
+  sigh(force: true)
+end
+```
+
+`force: true` will make sure to re-generate the provisioning profile on each run.
+This will result in _sigh_ always using the correct signing certificate, which is installed on the local machine.
+
+
+# Repair
+
+_sigh_ can automatically repair all your existing provisioning profiles which are expired or just invalid.
+
+```no-highlight
+fastlane sigh repair
+```
+
+# Resign
+
+If you generated your `ipa` file but want to apply a different code signing onto the ipa file, you can use `sigh resign`:
+
+```no-highlight
+fastlane sigh resign
+```
+
+_sigh_ will find the ipa file and the provisioning profile for you if they are located in the current folder.
+
+You can pass more information using the command line:
+
+```no-highlight
+fastlane sigh resign ./path/app.ipa --signing_identity "iPhone Distribution: Felix Krause" -p "my.mobileprovision"
+```
+
+# Manage
+
+With `sigh manage` you can list all provisioning profiles installed locally.
+
+```no-highlight
+fastlane sigh manage
+```
+
+Delete all expired provisioning profiles
+
+```no-highlight
+fastlane sigh manage -e
+```
+
+Or delete all `iOS Team Provisioning Profile` by using a regular expression
+
+```no-highlight
+fastlane sigh manage -p "iOS\ ?Team Provisioning Profile:"
+```
+
+## Environment Variables
+
+Run `fastlane action sigh` to get a list of all available environment variables.
+
+If you're using [_cert_](https://docs.fastlane.tools/actions/cert/) in combination with [_fastlane_](https://fastlane.tools) the signing certificate will automatically be selected for you. (make sure to run _cert_ before _sigh_)
+
+# How does it work?
+
+_sigh_ will access the `iOS Dev Center` to download, renew or generate the `.mobileprovision` file. It uses [_spaceship_](https://spaceship.airforce) to communicate with Apple's web services.
+
+## How is my password stored?
+_sigh_ uses the [CredentialsManager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from _fastlane_.
+
+# Tips
+
+## Use 'ProvisionQL' for advanced Quick Look in Finder
+
+Install [ProvisionQL](https://github.com/ealeksandrov/ProvisionQL).
+
+It will show you `mobileprovision` files like this:
+![img/actions/QuickLookScreenshot-Provision.png](/img/actions/QuickLookScreenshot-Provision.png)
+
+## App Identifier couldn't be found
+
+If you also want to create a new App Identifier on the Apple Developer Portal, check out [_produce_](https://docs.fastlane.tools/actions/produce/), which does exactly that.
+
+## What happens to my Xcode managed profiles?
+
+_sigh_ will never touch or use the profiles which are created and managed by Xcode. Instead _sigh_ will manage its own set of provisioning profiles.

data/fastlane/lib/fastlane/actions/docs/get_push_certificate.md

@@ -0,0 +1,134 @@
+<p align="center">
+  <img src="/img/actions/pem.png" width="250">
+</p>
+
+###### Automatically generate and renew your push notification profiles
+
+Tired of manually creating and maintaining your push notification profiles for your iOS apps? Tired of generating a _pem_ file for your server?
+
+_pem_ does all that for you, just by simply running _pem_.
+
+_pem_ creates new .pem, .cer, and .p12 files to be uploaded to your push server if a valid push notification profile is needed. _pem_ does not cover uploading the file to your server.
+
+To automate iOS Provisioning profiles you can use [_match_](https://docs.fastlane.tools/actions/match/).
+
+-------
+
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a> &bull;
+    <a href="#tips">Tips</a> &bull;
+    <a href="#need-help">Need help?</a>
+</p>
+
+-------
+
+<h5 align="center"><em>pem</em> is part of <a href="https://fastlane.tools">fastlane</a>: The easiest way to automate beta deployments and releases for your iOS and Android apps.</h5>
+
+# Features
+Well, it's actually just one: Generate the _pem_ file for your server.
+
+Check out this gif:
+
+![img/actions/PEMRecording.gif](/img/actions/PEMRecording.gif)
+
+# Usage
+
+```no-highlight
+fastlane pem
+```
+
+Yes, that's the whole command!
+
+This does the following:
+
+- Create a new signing request
+- Create a new push certification
+- Downloads the certificate
+- Generates a new ```.pem``` file in the current working directory, which you can upload to your server
+
+Note that _pem_ will never revoke your existing certificates. _pem_ can't download any of your existing push certificates, as the private key is only available on the machine it was created on. 
+
+If you already have a push certificate enabled, which is active for at least 30 more days, _pem_ will not create a new certificate. If you still want to create one, use the `force`:
+
+```no-highlight
+fastlane pem --force
+```
+
+You can pass parameters like this:
+
+```no-highlight
+fastlane pem -a com.krausefx.app -u username
+```
+
+If you want to generate a development certificate instead:
+
+```no-highlight
+fastlane pem --development
+```
+
+If you want to generate a Website Push certificate:
+
+```no-highlight
+fastlane pem --website_push
+```
+
+Set a password for your `p12` file:
+
+```no-highlight
+fastlane pem -p "MyPass"
+```
+
+You can specify a name for the output file:
+
+```no-highlight
+fastlane pem -o my.pem
+```
+
+To get a list of available options run:
+
+```no-highlight
+fastlane action pem
+```
+
+
+### Note about empty `p12` passwords and Keychain Access.app
+
+_pem_ will produce a valid `p12` without specifying a password, or using the empty-string as the password.
+While the file is valid, the Mac's Keychain Access will not allow you to open the file without specifying a passphrase.
+
+Instead, you may verify the file is valid using OpenSSL:
+
+```no-highlight
+openssl pkcs12 -info -in my.p12
+```
+
+If you need the `p12` in your keychain, perhaps to test push with an app like [Knuff](https://github.com/KnuffApp/Knuff) or [Pusher](https://github.com/noodlewerk/NWPusher), you can use `openssl` to export the `p12` to _pem_ and back to `p12`:
+
+```no-highlight
+% openssl pkcs12 -in my.p12 -out my.pem
+Enter Import Password:
+  <hit enter: the p12 has no password>
+MAC verified OK
+Enter PEM pass phrase:
+  <enter a temporary password to encrypt the pem file>
+
+% openssl pkcs12 -export -in my.pem -out my-with-passphrase.p12
+Enter pass phrase for temp.pem:
+  <enter the temporary password to decrypt the pem file>
+
+Enter Export Password:
+  <enter a password for encrypting the new p12 file>
+```
+
+## Environment Variables
+
+Run `fastlane action pem` to get a list of available environment variables.
+
+# How does it work?
+
+_pem_ uses [_spaceship_](https://spaceship.airforce) to communicate with the Apple Developer Portal to request a new push certificate for you.
+
+## How is my password stored?
+_pem_ uses the [password manager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from _fastlane_. Take a look the [CredentialsManager README](https://github.com/fastlane/fastlane/tree/master/credentials_manager) for more information.

data/fastlane/lib/fastlane/actions/docs/run_tests.md

@@ -0,0 +1,151 @@
+<p align="center">
+  <img src="/img/actions/scan.png" width="250">
+</p>
+
+###### The easiest way to run tests of your iOS and Mac app
+
+_scan_ makes it easy to run tests of your iOS and Mac app on a simulator or connected device.
+
+-------
+
+<p align="center">
+    <a href="#whats-scan">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#scanfile">Scanfile</a>
+</p>
+
+-------
+
+# What's scan?
+
+![https://pbs.twimg.com/media/CURcEpuWoAArE3d.png:large](https://pbs.twimg.com/media/CURcEpuWoAArE3d.png:large)
+
+### Before _scan_
+
+```no-highlight
+xcodebuild \
+  -workspace MyApp.xcworkspace \
+  -scheme "MyApp" \
+  -sdk iphonesimulator \
+  -destination 'platform=iOS Simulator,name=iPhone 6,OS=8.1' \
+  test
+```
+
+As the output will look like this
+
+```no-highlight
+/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.o Example/main.m normal arm64 objective-c com.apple.compilers.llvm.clang.1_0.compiler
+    cd /Users/felixkrause/Developer/fastlane/gym/example/cocoapods
+    export LANG=en_US.US-ASCII
+    export PATH="/Applications/Xcode-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin:/Applications/Xcode-beta.app/Contents/Developer/usr/bin:/Users/felixkrause/.rvm/gems/ruby-2.2.0/bin:/Users/felixkrause/.rvm/gems/ruby-2.2.0@global/bin:/Users/felixkrause/.rvm/rubies/ruby-2.2.0/bin:/Users/felixkrause/.rvm/bin:/usr/local/heroku/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
+    /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -x objective-c -arch arm64 -fmessage-length=126 -fdiagnostics-show-note-include-stack -fmacro-backtrace-limit=0 -fcolor-diagnostics -std=gnu99 -fobjc-arc -fmodules -gmodules -fmodules-cache-path=/Users/felixkrause/Library/Developer/Xcode/DerivedData/ModuleCache -fmodules-prune-interval=86400 -fmodules-prune-after=345600 -fbuild-session-file=/Users/felixkrause/Library/Developer/Xcode/DerivedData/ModuleCache/Session.modulevalidation -fmodules-validate-once-per-build-session -Wnon-modular-include-in-framework-module -Werror=non-modular-include-in-framework-module -Wno-trigraphs -fpascal-strings -Os -fno-common -Wno-missing-field-initializers -Wno-missing-prototypes -Werror=return-type -Wunreachable-code -Wno-implicit-atomic-properties -Werror=deprecated-objc-isa-usage -Werror=objc-root-class -Wno-arc-repeated-use-of-weak -Wduplicate-method-match -Wno-missing-braces -Wparentheses -Wswitch -Wunused-function -Wno-unused-label -Wno-unused-parameter -Wunused-variable -Wunused-value -Wempty-body -Wconditional-uninitialized -Wno-unknown-pragmas -Wno-shadow -Wno-four-char-constants -Wno-conversion -Wconstant-conversion -Wint-conversion -Wbool-conversion -Wenum-conversion -Wshorten-64-to-32 -Wpointer-sign -Wno-newline-eof -Wno-selector -Wno-strict-selector-match -Wundeclared-selector -Wno-deprecated-implementations -DCOCOAPODS=1 -DNS_BLOCK_ASSERTIONS=1 -DOBJC_OLD_DISPATCH_PROTOTYPES=0 -isysroot /Applications/Xcode-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS9.0.sdk -fstrict-aliasing -Wprotocol -Wdeprecated-declarations -miphoneos-version-min=9.0 -g -fvisibility=hidden -Wno-sign-conversion -fembed-bitcode -iquote /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-generated-files.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-own-target-headers.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-all-target-headers.hmap -iquote /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-project-headers.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/BuildProductsPath/Release-iphoneos/include -I/Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public -I/Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public/HexColors -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/DerivedSources/arm64 -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/DerivedSources -F/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/BuildProductsPath/Release-iphoneos -isystem /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public -isystem /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public/HexColors -MMD -MT dependencies -MF /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.d --serialize-diagnostics /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.dia -c /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Example/main.m -o /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.o
+```
+you'll probably want to use something like [xcpretty](https://github.com/supermarin/xcpretty), which will look like this:
+
+```no-highlight
+set -o pipefail &&
+  xcodebuild \
+    -workspace MyApp.xcworkspace \
+    -scheme "MyApp" \
+    -sdk iphonesimulator \
+    -destination 'platform=iOS Simulator,name=iPhone 6,OS=8.1' \
+    test \
+  | xcpretty \
+    -r "html" \
+    -o "tests.html"
+```
+
+### With _scan_
+
+```no-highlight
+fastlane scan
+```
+
+### Why _scan_?
+
+_scan_ uses the latest APIs and tools to make running tests plain simple and offer a great integration into your existing workflow, like [_fastlane_](https://fastlane.tools) or Jenkins.
+
+|          |  scan Features  |
+|----------|-----------------|
+🏁 | Beautiful inline build output while running the tests
+🚠 | Sensible defaults: Automatically detect the project, schemes and more
+📊 | Support for HTML, JSON and JUnit reports
+🔎 | Xcode duplicated your simulators again? _scan_ will handle this for you
+🔗 | Works perfectly with [_fastlane_](https://fastlane.tools) and other tools
+🚅 | Don't remember any complicated build commands, just _scan_
+🔧 | Easy and dynamic configuration using parameters and environment variables
+📢 | Beautiful slack notifications of the test results
+💾 | Store common build settings in a `Scanfile`
+📤 | The raw `xcodebuild` outputs are stored in `~/Library/Logs/scan`
+💻 | Supports both iOS and Mac applications
+👱 | Automatically switches to the [travis formatter](https://github.com/kattrali/xcpretty-travis-formatter) when running on Travis
+📖 | Helps you resolve common test errors like simulator not responding
+
+_scan_ uses a plain `xcodebuild` command, therefore keeping 100% compatible with `xcodebuild`. To generate the nice output, _scan_ uses [xcpretty](https://github.com/supermarin/xcpretty). You can alway access the raw output in `~/Library/Logs/scan`.
+
+![img/actions/scanScreenshot.png](/img/actions/scanScreenshot.png)
+![img/actions/slack.png](/img/actions/slack.png)
+![img/actions/scanHTML.png](/img/actions/scanHTML.png)
+![img/actions/scanHTMLFailing.png](/img/actions/scanHTMLFailing.png)
+
+# Usage
+
+```no-highlight
+fastlane scan
+```
+
+That's all you need to run your tests. If you want more control, here are some available parameters:
+
+```no-highlight
+fastlane scan --workspace "Example.xcworkspace" --scheme "AppName" --device "iPhone 6" --clean
+```
+
+If you need to use a different xcode install, use `xcode-select` or define `DEVELOPER_DIR`:
+
+```no-highlight
+DEVELOPER_DIR="/Applications/Xcode6.2.app" scan
+```
+
+To run _scan_ on multiple devices via [_fastlane_](https://fastlane.tools), add this to your `Fastfile`:
+
+```ruby
+scan(
+  workspace: "Example.xcworkspace",
+  devices: ["iPhone 6s", "iPad Air"]
+)
+```
+
+For a list of all available parameters use
+
+```no-highlight
+fastlane action scan
+```
+
+To access the raw `xcodebuild` output open `~/Library/Logs/scan`
+
+# Scanfile
+
+Since you might want to manually trigger the tests but don't want to specify all the parameters every time, you can store your defaults in a so called `Scanfile`.
+
+Run `fastlane scan init` to create a new configuration file. Example:
+
+```ruby-skip-tests
+scheme("Example")
+devices(["iPhone 6s", "iPad Air"])
+
+clean(true)
+
+output_types("html")
+```
+
+# Automating the whole process
+
+_scan_ works great together with [_fastlane_](https://fastlane.tools), which connects all deployment tools into one streamlined workflow.
+
+Using _fastlane_ you can define a configuration like
+
+```ruby
+lane :test do
+  scan(scheme: "Example")
+end
+```