Documentation

Go To Dashboard

Suggest an edit

Travis CI

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

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

deploy:
  provider: testfairy
  api-key: "TESTFAIRY API KEY"
  app-file: Path to the app file (APK/IPA)

You can find your API key on TestFairy settings page.

It is recommended that you encrypt your api-key. If you have the Travis CI command line client installed, you can run the following command in your repository directory:

$ travis encrypt "YOUR API KEY" --add deploy.api-key

Android

To deploy your Android application you need to specify your keystore certificate:

deploy:
  provider: testfairy
  api-key: "TESTFAIRY API KEY"
  app-file: Path to the app file (APK/IPA)
  keystore-file: Path to your keystore-file
  storepass: storepass
  alias: alias

Always encrypt your keystore file.

Symbols file

Attach your symbols mapping file so TestFairy can de-obfuscate and symbolicate crash reports automatically. Set the symbols-file key to 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-seperated 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: false
  testers-groups: qa-stuff,friends

More Options


  • auto-update: Upgrade previous installations to this version automatically.
  • max-duration: Maximum session recording length, eg "60m". Default is "10m".
  • data-only-wifi: Record video and metrics only when connected to wifi network.
  • video: If true, Video recording settings "true", "false". Default is "true".
  • video-quality: Video quality settings, "high", "medium" or "low". Default is "high".
  • screenshot-interval: Seconds between video frames. Default "1" seconds.
  • record-on-background: If true, data will be collected while the app on background.
  • metrics: Comma-separated list of metrics to record. View list on Upload parameters.
  • advanced-options: Additional settings (eg shake,anonymous).

For example:

deploy:
  provider: testfairy
  api-key: "TESTFAIRY API KEY"
  app-file: bin/MainActivity_release.apk
  symbols-file: bin/proguard_mapping.txt
  keystore-file: /root/app.keystore
  storepass: swordfish
  alias: android
  testers-groups: qa-stuff,friends
  auto-update: true
  screenshot-interval: 2
  video: true
  video-quality: high
  data-only-wifi: true
  metrics: cpu,memory,network,phone-signal,logcat,gps,battery
  advanced-options: shake,anonymous