fastlane 2.61.0.beta.20171006010004 → 2.61.0.beta.20171007010004

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

@@ -0,0 +1,120 @@
+<p align="center">
+  <img src="/img/actions/pem.png" height="110">
+</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://github.com/fastlane/fastlane/tree/master/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"><code>pem</code> 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](assets/PEMRecording.gif)
+
+# Usage
+
+    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`:
+
+    fastlane pem --force
+
+You can pass parameters like this:
+
+    fastlane pem -a com.krausefx.app -u username
+
+If you want to generate a development certificate instead:
+
+    fastlane pem --development
+
+Set a password for your `p12` file:
+
+    fastlane pem -p "MyPass"
+
+You can specify a name for the output file:
+
+    fastlane pem -o my.pem
+
+To get a list of available options run:
+
+    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:
+
+    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`:
+
+    % 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>
+
+##### [Do you like fastlane? Be the first to know about updates and new fastlane tools](https://tinyletter.com/fastlane-tools)
+
+## 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.
+
+# Tips
+
+## Use the 'Provisioning Quicklook plugin'
+Download and install the [Provisioning Plugin](https://github.com/chockenberry/Provisioning).
+
+It will show you the ``_pem_`` files like this:
+![img/actions/QuickLookScreenshot.png](assets/QuickLookScreenshot.png)

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

@@ -0,0 +1,218 @@
+<p align="center">
+  <img src="/img/actions/PilotTextTransparentSmall.png" width="500">
+</p>
+
+###### The best way to manage your TestFlight testers and builds from your terminal
+
+Pilot makes it easier to manage your app on Apple’s TestFlight. You can:
+
+- Upload & distribute builds
+- Add & remove testers
+- Retrieve information about testers & devices
+- Import/export all available testers
+
+_pilot_ uses [spaceship.airforce](https://spaceship.airforce) to interact with iTunes Connect 🚀
+
+-------
+
+<p align="center">
+    <a href="#usage">Usage</a> &bull;
+    <a href="#tips">Tips</a>
+</p>
+
+-------
+
+<h5 align="center"><code>pilot</code> 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>
+
+# Usage
+
+For all commands you can specify the Apple ID to use using `-u felix@krausefx.com`. If you execute _pilot_ in a project already using [fastlane](https://fastlane.tools) the username and app identifier will automatically be determined.
+
+## Uploading builds
+
+To upload a new build, just run
+
+```no-highlight
+fastlane pilot upload
+```
+
+This will automatically look for an `ipa` in your current directory and tries to fetch the login credentials from your [fastlane setup](https://fastlane.tools).
+
+You'll be asked for any missing information. Additionally, you can pass all kinds of parameters:
+
+```no-highlight
+fastlane action pilot
+```
+
+You can pass a changelog using
+
+```no-highlight
+fastlane pilot upload --changelog "Something that is new here"
+```
+
+You can also skip the submission of the binary, which means, the `ipa` file will only be uploaded and not distributed to testers:
+
+```no-highlight
+fastlane pilot upload --skip_submission
+```
+
+_pilot_ does all kinds of magic for you:
+
+- Automatically detects the bundle identifier from your `ipa` file
+- Automatically fetch the AppID of your app based on the bundle identifier
+
+_pilot_ uses [spaceship](https://spaceship.airforce) to submit the build metadata and the iTunes Transporter to upload the binary. Because iTunes Transporter's upload capability is only supported on OS X, `pilot upload` does not work on Linux, as described [in this issue](https://github.com/fastlane/fastlane/issues/5789)
+
+## List builds
+
+To list all builds for specific application use
+
+```no-highlight
+fastlane pilot builds
+```
+
+The result lists all active builds and processing builds:
+
+```no-highlight
++-----------+---------+----------+----------+----------+
+|                   Great App Builds                   |
++-----------+---------+----------+----------+----------+
+| Version # | Build # | Testing  | Installs | Sessions |
++-----------+---------+----------+----------+----------+
+| 0.9.13    | 1       | Expired  | 1        | 0        |
+| 0.9.13    | 2       | Expired  | 0        | 0        |
+| 0.9.20    | 3       | Expired  | 0        | 0        |
+| 0.9.20    | 4       | Internal | 5        | 3        |
++-----------+---------+----------+----------+----------+
+```
+
+## Managing beta testers
+
+### List of Testers
+
+This command will list all your testers, both internal and external.
+
+```no-highlight
+fastlane pilot list
+```
+
+The output will look like this:
+
+```no-highlight
++--------+--------+--------------------------+-----------+
+|                    Internal Testers                    |
++--------+--------+--------------------------+-----------+
+| First  | Last   | Email                    | # Devices |
++--------+--------+--------------------------+-----------+
+| Felix  | Krause | felix@krausefx.com       | 2         |
++--------+--------+--------------------------+-----------+
+
++-----------+---------+----------------------------+-----------+
+|                       External Testers                       |
++-----------+---------+----------------------------+-----------+
+| First     | Last    | Email                      | # Devices |
++-----------+---------+----------------------------+-----------+
+| Max       | Manfred | email@email.com            | 0         |
+| Detlef    | Müller  | detlef@krausefx.com        | 1         |
++-----------+---------+----------------------------+-----------+
+```
+
+### Add a new tester
+
+To add a new tester to both your iTunes Connect account and to your app (if given), use the `pilot add` command. This will create a new tester (if necessary) or add an existing tester to the app to test.
+
+```no-highlight
+fastlane pilot add email@invite.com
+```
+
+Additionally you can specify the app identifier (if necessary):
+
+```no-highlight
+fastlane pilot add email@email.com -a com.krausefx.app
+```
+
+### Find a tester
+
+To find a specific tester use
+
+```no-highlight
+fastlane pilot find felix@krausefx.com
+```
+
+The resulting output will look like this:
+
+```no-highlight
++---------------------+---------------------+
+|            felix@krausefx.com             |
++---------------------+---------------------+
+| First name          | Felix               |
+| Last name           | Krause              |
+| Email               | felix@krausefx.com  |
+| Latest Version      | 0.9.14 (23          |
+| Latest Install Date | 03/28/15 19:00      |
+| 2 Devices           | • iPhone 6, iOS 8.3 |
+|                     | • iPhone 5, iOS 7.0 |
++---------------------+---------------------+
+```
+
+### Remove a tester
+
+This command will only remove external beta testers.
+
+```no-highlight
+fastlane pilot remove felix@krausefx.com
+```
+
+### Export testers
+
+To export all external testers to a CSV file. Useful if you need to import tester info to another system or a new account.
+
+```no-highlight
+fastlane pilot export
+```
+
+### Import testers
+
+Add external testers from a CSV file. Sample CSV file available [here](https://itunesconnect.apple.com/itc/docs/tester_import.csv).
+
+```no-highlight
+fastlane pilot import
+```
+
+You can also specify the directory using
+
+```no-highlight
+fastlane pilot export -c ~/Desktop/testers.csv
+fastlane pilot import -c ~/Desktop/testers.csv
+```
+
+# Tips
+
+## Debug information
+
+If you run into any issues you can use the `verbose` mode to get a more detailed output:
+
+    fastlane pilot upload --verbose
+
+## Firewall Issues
+
+_pilot_ uses the iTunes Transporter to upload metadata and binaries. In case you are behind a firewall, you can specify a different transporter protocol from the command line using
+
+```no-highlight
+DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS="-t DAV" pilot ...
+```
+
+If you are using _pilot_ via the [fastlane action](https://docs.fastlane.tools/actions#pilot), add the following to your `Fastfile`
+
+```no-highlight
+ENV["DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS"] = "-t DAV"
+pilot...
+```
+
+## Credentials Issues
+
+If your password contains special characters, _pilot_ may throw a confusing error saying your "Your Apple ID or password was entered incorrectly". The easiest way to fix this error is to change your password to something that **does not** contains special characters.
+
+## How is my password stored?
+
+_pilot_ uses the [CredentialsManager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from _fastlane_.

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

@@ -0,0 +1,97 @@
+<p align="center">
+  <img src="/img/actions/precheck.png" height="110">
+</p>
+
+Precheck
+============
+
+###### Check your app using a community driven set of App Store review rules to avoid being rejected
+
+Apple rejects builds for many avoidable metadata issues like including swear words 😮, other companies’ trademarks, or even mentioning an iOS bug 🐛. _fastlane precheck_ takes a lot of the guess work out by scanning your app’s details in iTunes Connect for avoidable problems. fastlane precheck helps you get your app through app review without rejections so you can ship faster 🚀
+
+-------
+
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#example">Example</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a>
+</p>
+
+-------
+
+# Features
+
+
+|          |  precheck Features  |
+|----------|-----------------|
+|🐛|  product bug mentions|
+|🙅‍♂️|Swear word checker|
+|🤖|Mentioning other platforms|
+|😵|URL reachability checker|
+|📝|Placeholder/test words/mentioning future features|
+|📅|Copyright date checking|
+|🙈|Customizable word list checking|
+|📢|You can decide if you want to warn  about potential problems and continue or have _fastlane_ show an error and stop after all scans are done.|
+
+# Usage
+Run _fastlane precheck_ to check the app metadata from iTunes Connect
+
+    fastlane precheck
+
+To get a list of available options run
+    
+    fastlane action precheck
+
+<img src="/img/actions/precheck.gif" />
+    
+# Example
+
+Since you might want to manually trigger _precheck_ but don't want to specify all the parameters every time, you can store your defaults in a so called `Precheckfile`.
+
+Run `fastlane precheck init` to create a new configuration file. Example:
+
+```ruby
+# indicates that your metadata will not be checked by this rule
+negative_apple_sentiment(level: :skip)
+
+# when triggered, this rule will warn you of a potential problem
+curse_words(level: :warn)
+
+# show error and prevent any further commands from running after fastlane precheck finishes
+unreachable_urls(level: :error)
+
+# pass in whatever words you want to check for
+custom_text(data: ["chrome", "webos"], 
+           level: :warn)
+``` 
+
+### Use with [_fastlane_](https://github.com/fastlane/fastlane/tree/master/fastlane)
+
+_precheck_ is fully integrated with [_deliver_](https://github.com/fastlane/fastlane/tree/master/deliver) another [_fastlane_](https://github.com/fastlane/fastlane/tree/master/fastlane) tool.
+
+Update your `Fastfile` to contain the following code:
+
+```ruby
+lane :production do
+  ...
+  # by default deliver will call precheck and warn you of any problems
+  # if you want precheck to halt submitting to app review, you can pass
+  # precheck_default_rule_level: :error
+  deliver(precheck_default_rule_level: :error)
+  ...
+end
+
+# or if you prefer, you can run precheck alone
+lane :check_metadata do
+  precheck
+end
+
+```
+
+# How does it work?
+
+_precheck_ will access `iTunes Connect` to download your app's metadata. It uses [spaceship](https://spaceship.airforce) to communicate with Apple's web services.
+
+# Want to improve precheck's rules?
+Please submit an issue on GitHub and provide information about your App Store rejection! Make sure you scrub out any personally identifiable information since this will be public.

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

@@ -0,0 +1,227 @@
+<p align="center">
+  <img src="/img/actions/produce.png" height="110">
+</p>
+
+###### Create new iOS apps on iTunes Connect and Dev Portal using your command line
+
+_produce_ creates new iOS apps on both the Apple Developer Portal and iTunes Connect with the minimum required information.
+
+-------
+
+<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>
+</p>
+
+-------
+
+# Features
+
+- **Create** new apps on both iTunes Connect and the Apple Developer Portal
+- **Modify** Application Services on the Apple Developer Portal
+- **Create** App Groups on the Apple Developer Portal
+- **Associate** apps with App Groups on the Apple Developer Portal
+- **Create** Merchant Identifiers on the Apple Developer Portal
+- **Associate** apps with Merchant Identifiers on the Apple Developer Portal
+- Support for **multiple Apple accounts**, storing your credentials securely in the Keychain
+
+# Usage
+
+## Creating a new application
+
+    fastlane produce
+
+To get a list of all available parameters:
+
+    fastlane produce --help
+
+```no-highlight
+  Commands: (* default)
+    associate_group      Associate with a group, which is created if needed or simply located otherwise
+    associate_merchant   Associate with a merchant for use with Apple Pay. Apple Pay will be enabled for this app
+    create             * Creates a new app on iTunes Connect and the Apple Developer Portal
+    disable_services     Disable specific Application Services for a specific app on the Apple Developer Portal
+    enable_services      Enable specific Application Services for a specific app on the Apple Developer Portal
+    group                Ensure that a specific App Group exists
+    help                 Display global or [command] help documentation
+    merchant             Ensure that a specific Merchant exists
+
+  Global Options:
+    --verbose
+    -h, --help           Display help documentation
+    -v, --version        Display version information
+
+  Options for create:
+    -u, --username STRING Your Apple ID Username (PRODUCE_USERNAME)
+    -a, --app_identifier STRING App Identifier (Bundle ID, e.g. com.krausefx.app) (PRODUCE_APP_IDENTIFIER)
+    -e, --bundle_identifier_suffix STRING App Identifier Suffix (Ignored if App Identifier does not ends with .*) (PRODUCE_APP_IDENTIFIER_SUFFIX)
+    -q, --app_name STRING App Name (PRODUCE_APP_NAME)
+    -z, --app_version STRING Initial version number (e.g. '1.0') (PRODUCE_VERSION)
+    -y, --sku STRING     SKU Number (e.g. '1234') (PRODUCE_SKU)
+    -j, --platform STRING The platform to use (optional) (PRODUCE_PLATFORM)
+    -m, --language STRING Primary Language (e.g. 'English', 'German') (PRODUCE_LANGUAGE)
+    -c, --company_name STRING The name of your company. Only required if it's the first app you create (PRODUCE_COMPANY_NAME)
+    -i, --skip_itc [VALUE] Skip the creation of the app on iTunes Connect (PRODUCE_SKIP_ITC)
+    -d, --skip_devcenter [VALUE] Skip the creation of the app on the Apple Developer Portal (PRODUCE_SKIP_DEVCENTER)
+    -s, --itc_users ARRAY 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 (ITC_USERS)
+    -b, --team_id STRING The ID of your Developer Portal team if you're in multiple teams (PRODUCE_TEAM_ID)
+    -l, --team_name STRING The name of your Developer Portal team if you're in multiple teams (PRODUCE_TEAM_NAME)
+    -k, --itc_team_id [VALUE] The ID of your iTunes Connect team if you're in multiple teams (PRODUCE_ITC_TEAM_ID)
+    -p, --itc_team_name STRING The name of your iTunes Connect team if you're in multiple teams (PRODUCE_ITC_TEAM_NAME)
+```
+
+## Enabling / Disabling Application Services
+
+If you want to enable Application Services for an App ID (HomeKit and HealthKit in this example):
+
+    fastlane produce enable_services --homekit --healthkit
+
+If you want to disable Application Services for an App ID (iCloud in this case):
+
+    fastlane produce disable_services --icloud
+
+If you want to create a new App Group:
+
+    fastlane produce group -g group.krausefx -n "Example App Group"
+
+If you want to associate an app with an App Group:
+
+    fastlane produce associate_group -a com.krausefx.app group.krausefx
+
+# Parameters
+
+Get a list of all available options using
+
+```no-highlight
+fastlane produce enable_services --help
+```
+
+```no-highlight
+    --app-group          Enable App Groups
+    --apple-pay          Enable Apple Pay
+    --associated-domains Enable Associated Domains
+    --data-protection STRING Enable Data Protection, suitable values are "complete", "unlessopen" and "untilfirstauth"
+    --game-center        Enable Game Center
+    --healthkit          Enable HealthKit
+    --homekit            Enable HomeKit
+    --wireless-conf      Enable Wireless Accessory Configuration
+    --icloud STRING      Enable iCloud, suitable values are "legacy" and "cloudkit"
+    --in-app-purchase    Enable In-App Purchase
+    --inter-app-audio    Enable Inter-App-Audio
+    --passbook           Enable Passbook
+    --push-notification  Enable Push notification (only enables the service, does not configure certificates)
+    --sirikit            Enable SiriKit
+    --vpn-conf           Enable VPN Configuration
+```
+
+```no-highlight
+fastlane produce disable_services --help
+```
+
+```
+    --app-group          Disable App Groups
+    --apple-pay          Disable Apple Pay
+    --associated-domains Disable Associated Domains
+    --data-protection    Disable Data Protection
+    --game-center        Disable Game Center
+    --healthkit          Disable HealthKit
+    --homekit            Disable HomeKit
+    --wireless-conf      Disable Wireless Accessory Configuration
+    --icloud             Disable iCloud
+    --in-app-purchase    Disable In-App Purchase
+    --inter-app-audio    Disable Inter-App-Audio
+    --passbook           Disable Passbook
+    --push-notification  Disable Push notifications
+    --sirikit            Disable SiriKit
+    --vpn-conf           Disable VPN Configuration
+```
+
+## Creating Apple Pay merchants and associating them with an App ID
+
+If you want to create a new Apple Pay Merchant Identifier:
+
+```no-highlight
+fastlane produce merchant -o merchant.com.example.production -r "Example Merchant Production"
+```
+
+Use `--help` for more information about all available parameters
+```
+fastlane produce merchant --help
+```
+
+If you want to associate an app with a Merchant Identifier:
+
+```no-highlight
+fastlane produce associate_merchant -a com.krausefx.app merchant.com.example.production
+```
+
+If you want to associate an app with multiple Merchant Identifiers:
+
+```no-highlight
+fastlane produce associate_merchant -a com.krausefx.app merchant.com.example.production merchant.com.example.sandbox
+```
+
+Use --help for more information about all available parameters
+
+```no-highlight
+fastlane produce associate_merchant --help
+```
+
+## Environment Variables
+
+All available values can also be passed using environment variables, run `fastlane produce --help` to get a list of all available parameters.
+
+## _fastlane_ Integration
+
+Your `Fastfile` should look like this
+
+```ruby
+lane :release do
+  produce(
+    username: 'felix@krausefx.com',
+    app_identifier: 'com.krausefx.app',
+    app_name: 'MyApp',
+    language: 'English',
+    app_version: '1.0',
+    sku: '123',
+    team_name: 'SunApps GmbH' # only necessary when in multiple teams
+    
+    # Optional
+    # App services can be enabled during app creation
+    enable_services: {
+      app_group: "on"               # Valid values: "on", "off"
+      apple_pay: "on"               # Valid values: "on", "off"
+      associated_domains: "on"      # Valid values: "on", "off"
+      data_protection: "complete"   # Valid values: "complete", "unlessopen", "untilfirstauth"
+      game_center: "on"             # Valid values: "on", "off"
+      health_kit: "on"              # Valid values: "on", "off"
+      home_kit: "on"                # Valid values: "on", "off"
+      wireless_accessory: "on"      # Valid values: "on", "off"
+      icloud: "cloudkit"            # Valid values: "legacy", "cloudkit"
+      in_app_purchase: "on"         # Valid values: "on", "off"
+      inter_app_audio: "on"         # Valid values: "on", "off"
+      passbook: "on"                # Valid values: "on", "off"
+      push_notification: "on"       # Valid values: "on", "off"
+      siri_kit: "on"                # Valid values: "on", "off"
+      vpn_configuration: "on"       # Valid values: "on", "off"
+    }
+  )
+
+  deliver
+end
+```
+
+To use the newly generated app in _deliver_, you need to add this line to your `Deliverfile`:
+
+```ruby
+apple_id ENV['PRODUCE_APPLE_ID']
+```
+
+This will tell _deliver_, which `App ID` to use, since the app is not yet available in the App Store.
+
+You'll still have to fill out the remaining information (like screenshots, app description and pricing). You can use [deliver](https://github.com/fastlane/fastlane/tree/master/deliver) to upload your app metadata using a CLI
+
+## How is my password stored?
+
+_produce_ 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.