jacoco:report-aggregate
Note :This goal should be used as a Maven report.
Full name :
org.jacoco:jacoco-maven-plugin:0.8.13-SNAPSHOT:report-aggregate
Description :
Creates a structured code coverage report (HTML, XML, and CSV) from multiple projects within reactor. The report is created from all modules this project depends on, and optionally this project itself. From those projects class and source files as well as JaCoCo execution data files will be collected. In addition execution data is collected from the project itself. This also allows to create coverage reports when tests are in separate projects than the code under test, for example in case of integration tests.
Using the dependency scope allows to distinguish projects which contribute execution data but should not become part of the report:
-
compile,runtime,provided: Project source and execution data is included in the report. -
test: Only execution data is considered for the report.
Attributes :
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
-
Since version:
0.7.7.
Optional Parameters
| Name | Type | Since | Description |
<dataFileExcludes>
|
List
|
0.7.7
|
A list of execution data files to exclude from the report. May use
wildcard characters (* and ?). When not specified nothing will be
excluded.
|
<dataFileIncludes>
|
List
|
0.7.7
|
A list of execution data files to include in the report from each
project. May use wildcard characters (* and ?). When not specified
all *.exec files from the target folder will be included.
|
<excludes>
|
List
|
0.7.7
|
A list of class files to exclude from the report. May use wildcard
characters (* and ?). When not specified nothing will be excluded.
|
<footer>
|
String
|
0.7.7
|
Footer text used in HTML report pages.
|
<formats>
|
List
|
0.8.7
|
A list of report formats to generate. Supported formats are HTML,
XML and CSV. Defaults to all formats if no values are given.
Default value is : HTML,XML,CSV
.
|
<includeCurrentProject>
|
boolean
|
0.8.9
|
Include this project in the report. If true then this projects
class and source files as well as JaCoCo execution data files will
be collected.
Default value is : false
.
|
<includes>
|
List
|
0.7.7
|
A list of class files to include in the report. May use wildcard
characters (* and ?). When not specified everything will be
included.
|
<outputDirectory>
|
File
|
0.7.7
|
Output directory for the reports. Note that this parameter is only
relevant if the goal is run from the command line or from the
default build lifecycle. If the goal is run indirectly as part of a
site generation, the output directory configured in the Maven Site
Plugin is used instead.
Default value is : ${project.reporting.outputDirectory}/jacoco-aggregate
.
|
<outputEncoding>
|
String
|
0.7.7
|
Encoding of the generated reports.
Default value is : UTF-8
.
User property is : project.reporting.outputEncoding
.
|
<skip>
|
boolean
|
0.7.7
|
Flag used to suppress execution.
Default value is : false
.
User property is : jacoco.skip
.
|
<sourceEncoding>
|
String
|
0.7.7
|
Encoding of the source files.
Default value is : UTF-8
.
User property is : project.build.sourceEncoding
.
|
<title>
|
String
|
0.7.7
|
Name of the root node HTML report pages.
Default value is : ${project.name}
.
|
Parameter Details
<dataFileExcludes>A list of execution data files to exclude from the report. May use
wildcard characters (* and ?). When not specified nothing will be
excluded.
-
Type
:
java.util.List -
Since
:
0.7.7 -
Required
:
No
A list of execution data files to include in the report from each
project. May use wildcard characters (* and ?). When not specified
all *.exec files from the target folder will be included.
-
Type
:
java.util.List -
Since
:
0.7.7 -
Required
:
No
A list of class files to exclude from the report. May use wildcard
characters (* and ?). When not specified nothing will be excluded.
-
Type
:
java.util.List -
Since
:
0.7.7 -
Required
:
No
Footer text used in HTML report pages.
-
Type
:
java.lang.String -
Since
:
0.7.7 -
Required
:
No
A list of report formats to generate. Supported formats are HTML,
XML and CSV. Defaults to all formats if no values are given.
-
Type
:
java.util.List -
Since
:
0.8.7 -
Required
:
No -
Default
:
HTML,XML,CSV
Include this project in the report. If true then this projects
class and source files as well as JaCoCo execution data files will
be collected.
-
Type
:
boolean -
Since
:
0.8.9 -
Required
:
No -
Default
:
false
A list of class files to include in the report. May use wildcard
characters (* and ?). When not specified everything will be
included.
-
Type
:
java.util.List -
Since
:
0.7.7 -
Required
:
No
Output directory for the reports. Note that this parameter is only
relevant if the goal is run from the command line or from the
default build lifecycle. If the goal is run indirectly as part of a
site generation, the output directory configured in the Maven Site
Plugin is used instead.
-
Type
:
java.io.File -
Since
:
0.7.7 -
Required
:
No -
Default
:
${project.reporting.outputDirectory}/jacoco-aggregate
Encoding of the generated reports.
-
Type
:
java.lang.String -
Since
:
0.7.7 -
Required
:
No -
User Property
:
project.reporting.outputEncoding -
Default
:
UTF-8
Flag used to suppress execution.
-
Type
:
boolean -
Since
:
0.7.7 -
Required
:
No -
User Property
:
jacoco.skip -
Default
:
false
Encoding of the source files.
-
Type
:
java.lang.String -
Since
:
0.7.7 -
Required
:
No -
User Property
:
project.build.sourceEncoding -
Default
:
UTF-8
Name of the root node HTML report pages.
-
Type
:
java.lang.String -
Since
:
0.7.7 -
Required
:
No -
Default
:
${project.name}