HeadSpin provides a plugin to Jenkins that does a deep integration of the HeadSpin session with the Jenkins concept of build. Using the HeadSpin plugin, each session is tagged with the build_id. This allows viewing all devices in use during a build, as well as end of build statistics based on the HeadSpin performance data. This document will explain how to configure and use the plugin.

Usage of this plugin requires a HeadSpin API token. You must have a HeadSpin account to generate an API token. You can sign up for a new account at https://ui.headspin.io/register?referral=jenkins. Further configration of the plugin can be found under https://ui.headspin.io/mysettings.


The HeadSpin plugin is hosted at https://plugins.jenkins.io/headspin as well as the Jenkins Maven reposity under io.jenkins.plugins:headspin.

  1. Go to Manage Jenkins > Manage Plugins.
  2. Search for HeadSpin on Available tab.
  3. Check the Install box and click the Install without restart or Download now and install after restart button.

Set up

  1. Create a Freestyle project.

  2. Add Archive the artifacts on Post-Build Actions

  3. Enter the file path. (The base directory is the workspace).

    For example:

  4. Add HeadSpin Jenkins Plugin on Post-Build Actions.

  5. Add HeadSpin API Token.

  6. Enter Package Name for Android app or App Id for IOS app.

  7. Enter Activity Name of the app where automation tests will start from.

  8. Add HeadSpin Tests with selectors that choose a device and commands that run automation scripts.

    For example: Screenshot

  9. Save.



Summary page shows device views of running tests.



Analysis page ("HeadSpin Report") gives useful information about performance of your app.



1.0 (August 2019)

Initial release


jenkins-headspin-plugin is maintained by HeadSpin. HeadSpin is the next generation global platform for mobile app testing and monitoring.