Maven build tool - Sealights plugin

The SeaLights Maven plugin is designed to wrap the entire process (Build Scan + Test Listener functions) into the Maven lifecycle, allowing seamless integration with the build tool.

This solution uses the build scanner .jar file as well as a JSON configuration file. Once the jar is executed specifying the configuration file, the pom.xml files of the Maven project are altered to incorporate the SeaLights plugin. This can be reversed using another CLI command. Please refer to the dedicated page Recommended - Automatic configuration of Maven via a JSON file to proceed with the integration.

Sealights Maven plugin operates during specific Maven lifecycle phases:

  • Build Scanner is executed during process-classes

  • Tests executed during the test phase are captured

The option IncludeResources will add the Sealights' text files (sltoken and buildSessionId) to the target/classes folder during process-classes. These two text files will be added automatically to the artefact (.jar, .war,...) during the package phase as they're already placed in the relevant folder.

The following versions are the minimum required for integration with Maven test runners:

  • Surefire - version 2.8 and above

In addition to the ‘automatic update of POM file', we have kept backward compatibility of integrating Sealights plugin with your Maven build manually as described in Legacy - Defining a Sealights profile in the pom.xml file.
This solution requires to manually edit your project’s pom.xml files and add explicitly the Sealights plugin definition and settings. If you're onboarding a new application please avoid this method.

Here is the entire list of articles in this sub-section: