Prerequisites

Build Requirements

To capture test data, your build must meet the following requirements:

• Maven Surefire/Failsafe 3.0.0+ or Gradle 7.3+
• Test framework based on JUnit Platform 5.8+, such as
  • JUnit Jupiter
  • JUnit Vintage
  • Spock Framework
  • KoTest
  • Cucumber
  • TestNG
• Java 8+ runtime

Installing the GitHub app

Before you can start using TestLens you need to install the TestLens GitHub app from the GitHub Marketplace:

1. Choose the user or organization account you want to install TestLens for
2. Choose a plan that matches your account
3. Click on “Install” or “Install it for free”
4. Complete the marketplace flow

After the marketplace flow is completed, the GitHub app will be installed in the account you selected in step 1.

Setting up GitHub Actions

To collect data about test runs, TestLens needs to instrument your build. Therefore, you need to add the testlens-app/setup-testlens action to your GitHub Actions workflows.

GradleSetup instructions for Gradle builds

MavenSetup instructions for Maven builds