Source link: https://github.com/testfairy/testfairy-gradle-plugin

TestFairy Gradle Plugin

This plugin integrates TestFairy platform with the Gradle build system. With this plugin, you can upload signed builds directly via command line, IntelliJ, Android Studio and other IDEs.


A typical TestFairy Gradle Plugin installation takes less than 1 minute.

Installation consists of adding the following to your app module's build.gradle file:

apply plugin: 'testfairy'  buildscript {

  repositories {


maven {
 url 'https://www.testfairy.com/maven' 


dependencies {

classpath 'com.testfairy.plugins.gradle:testfairy:2.+'
  testfairyConfig {

  apiKey "1234567890abcdef"
  uploadProguardMapping true

NOTE: Your TestFairy API key is in your account settings


With the plugin installed, a set of new tasks, prefixed " testfairy" will be added, one for each build type.

For example: to upload a debug build, run the following from terminal:

gradlew testfairyDebug 

Optionally, you can add a changelog to this build. This changelog will appear in your build notes and as a default message when inviting testers. For example:

gradlew -PtestfairyChangelog="Fixed all bugs" testfairyDebug 

Additional Parameters

This Gradle plugin uploads APK artifacts to TestFairy for distribution. We strongly suggest you also integrate the TestFairy SDK. Additional parameters control the default behavior of newly uploaded builds:

Property Description
apiKey API key used for uploading
video Should record video? Values: on/off/wifi (default: on)
videoQuality Image quality of video. Values: high/medium/low (default: medium)
testersGroups Comma seperated list of testers-groups to invite
notify Should send emails to these testers? Values: true/false (default: true)
comment Comment text to attach to emails sent to testers
autoUpdate Display and enable auto update for testers using older versions? Values: true/false (default: false)
recordOnBackground Should record metrics even if app is in background (Android only)? Values: true/false (default: false)

Using a Web Proxy

Behind a firewall at work? TestFairy Gradle Plugin supports HTTP proxy via " http.proxyHost" system property. Please refer to the Accessing The Web Via a Proxy section in the Gradle user guide document.

Android Studio / IntelliJ

This plugin is also Android Studio and Intellij-friendly. To upload builds directly from your IDE:

  1. Open "Edit Configuration..." dialog

  1. Add a new Gradle configuration, use task " testfairyDebug" or another, depending on your build type.

Migrating from 1.x to 2.x

Version 2.0 deprecated the support for instrumentation. Please use the TestFairy SDK to record sessions, auto-update versions, and handle crashes.

To migrating, simply re-integrate the plugin into your module's build.gradle file.

  • iconWatermark has been removed


2.0 (2017-09-01)

  • Added support for latest Gradle and Android Plugin
  • Added support for Android Studio 3
  • Removed support for instrumentation
  • Removed dependency for zipaplign and jarsigner
  • Removed iconWatermark

1.12 (2015-02-04)

  • Removed dependency for 'zip' command.
  • Zipalign signed APK before uploading.
  • Compatible with JDK 1.6.


Please send bug reports to [email protected]


A nice breathing progress component.

Lightweight Android MVP library with easy implementation.

It's just an example of material transition.

A contextual actionbar library with many customization options.

An extended transition for android ViewPager.

Animate is a simple application to demonstrate meaningful motion on Android. This application takes a look at a bunch of different Material Style animations.


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes