TestFairy Deployment

This page documents deployments using the next major version dpl v2 which currently is in a beta release phase. Please see our blog post for details. The current default version is dpl v1. Check dpl v1 documentation here.

Travis CI can automatically deploy your Android and iOS Apps to TestFairy.

For a minimal configuration, add the following to your .travis.yml:

deploy:
  provider: testfairy
  api_key: <encrypted api_key>
  app_file: <app_file>
  edge: true # opt in to dpl v2

Status #

Support for deployments to TestFairy is in alpha. Please see Maturity Levels for details.

Known options #

Use the following options to further configure the deployment.

api_key TestFairy API key — required, secret, type: string
app_file Path to the app file that will be generated after the build (APK/IPA) — required, type: string
symbols_file Path to the symbols file — type: string
testers_groups Tester groups to be notified about this build — type: string, e.g.: e.g. group1,group1
notify Send an email with a changelog to your users — type: boolean
auto_update Automaticall upgrade all the previous installations of this app this version — type: boolean
advanced_options Comma_separated list of advanced options — type: string, e.g.: option1,option2

Shared options #

cleanup Clean up build artifacts from the Git working directory before the deployment — type: boolean
run Commands to execute after the deployment finished successfully — type: string or array of strings

Environment variables #

All options can be given as environment variables if prefixed with TESTFAIRY_.

For example, api_key can be given as TESTFAIRY_API_KEY=<api_key>.

Securing secrets #

Secret option values should be given as either encrypted strings in your build configuration (.travis.yml file) or environment variables in your repository settings.

Environment variables can be set on the settings page of your repository, or using travis env set:

travis env set TESTFAIRY_API_KEY <api_key>

In order to encrypt option values when adding them to your .travis.yml file use travis encrypt:

travis encrypt <api_key>

Or use --add to directly add it to your .travis.yml file. Note that this command has to be run in your repository’s root directory:

travis encrypt --add deploy.api_key <api_key>

You can find your API key on TestFairy settings page.

Symbols file #

Attach your symbols mapping file so TestFairy can de-obfuscate and symbolicate crash reports automatically. Set the symbols-file key to your proguard_mapping.txt file or to a zipped .dSYM file.

deploy:
  provider: testfairy
  # ⋮
  symbols_file: Path to the symbols file

Invite testers automatically #

To automatically invite testers upon build upload, specify a comma-separated list of groups in the testers-groups key. Set the notify key to true if you want to notify them via email:

deploy:
  provider: testfairy
  # ⋮
  notify: true
  testers_groups: qa-stuff,friends

Pull Requests #

Note that pull request builds skip the deployment step altogether.

See also #