coveralls:report

Full name:

com.github.hazendaz.maven:coveralls-maven-plugin:5.1.0:report

Description:

The Class CoverallsReportMojo.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator goal.
The goal is not marked as thread-safe and thus does not support parallel builds.

Optional Parameters

Name	Type	Since	Description
`<basedir>`	`File`	`-`	Base directory of the project. Default: `${project.basedir}` User Property: `coveralls.basedir`
`<branch>`	`String`	`-`	Git branch name. User Property: `branch`
`<cloverReports>`	`List<File>`	`-`	File paths to additional Clover coverage report files. User Property: `cloverReports`
`<coberturaReports>`	`List<File>`	`-`	Deprecated. Cobertura is deprecated and no longer maintained. Use JaCoCo instead. File paths to additional Cobertura coverage report files. Coveralls Maven Plugin 4.5.0 is last to work with Cobertura as java 8 required. User Property: `coberturaReports`
`<coverallsFile>`	`File`	`-`	File path to write and submit Coveralls data. Default: `${project.build.directory}/coveralls.json` User Property: `coverallsFile`
`<coverallsUrl>`	`String`	`-`	Url for the Coveralls API. Default: `https://coveralls.io/api/v1/jobs` User Property: `coverallsUrl`
`<dryRun>`	`boolean`	`-`	Dry run Coveralls report without actually sending it. Default: `false` User Property: `dryRun`
`<failOnServiceError>`	`boolean`	`-`	Fail build if Coveralls service is not available or submission fails for internal errors. Default: `true` User Property: `failOnServiceError`
`<jacocoAggregateReport>`	`File`	`5.0.0`	In a Maven Multi-Module project, it's common to configure JaCoCo with a Maven project that's used for aggregating all JaCoCo reports into a single location. In this circumstance use the "jacocoAggregateReport" property so that only this location is used for coverage rather than looking for JaCoCo reports in each Maven project. User Property: `jacocoAggregateReport`
`<jacocoReports>`	`List<File>`	`-`	File paths to additional JaCoCo coverage report files. By default, this plugin will look for a files in the standard JaCoCo locations. If a merged report is found in ${project.reporting.outputDirectory}/jacoco-merged-report/jacoco.xml then it will be used. Otherwise, the plugin will fallback to looking for files in both ${project.reporting.outputDirectory}/jacoco/jacoco.xml and ${project.reporting.outputDirectory}/jacoco-it/jacoco.xml If the "jacocoAggregateReport" property is set then this property will be ignored User Property: `jacocoReports`
`<parallel>`	`boolean`	`-`	Coveralls parallel flag. User Property: `parallel`
`<pullRequest>`	`String`	`-`	GitHub pull request identifier. User Property: `pullRequest`
`<relativeReportDirs>`	`List<String>`	`-`	Directories for relative per module specific report files. User Property: `relativeReportDirs`
`<repoToken>`	`String`	`-`	Coveralls repository token. User Property: `repoToken`
`<sagaReports>`	`List<File>`	`-`	File paths to additional Saga coverage report files. User Property: `sagaReports`
`<scanForSources>`	`boolean`	`-`	Scan subdirectories for source files. Default: `false` User Property: `scanForSources`
`<serviceBuildNumber>`	`String`	`-`	CI service build number. User Property: `serviceBuildNumber`
`<serviceBuildUrl>`	`String`	`-`	CI service build url. User Property: `serviceBuildUrl`
`<serviceEnvironment>`	`Properties`	`-`	CI service specific environment properties. User Property: `serviceEnvironment`
`<serviceJobId>`	`String`	`-`	CI service job id. User Property: `serviceJobId`
`<serviceName>`	`String`	`-`	CI service name. User Property: `serviceName`
`<skip>`	`boolean`	`-`	Skip the plugin execution. Default: `false` User Property: `coveralls.skip`
`<sourceDirectories>`	`List<File>`	`-`	Source directories. User Property: `sourceDirectories`
`<sourceEncoding>`	`String`	`-`	Source file encoding. Default: `${project.build.sourceEncoding}` User Property: `sourceEncoding`
`<timestamp>`	`String`	`-`	Build timestamp. Must be in format defined by 'timestampFormat' if it's available or in default timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'. Default: `${maven.build.timestamp}` User Property: `timestamp`
`<timestampFormat>`	`String`	`-`	Build timestamp format. Must be in format supported by DateTimeFormatter. Default: `${maven.build.timestamp.format}` User Property: `timestampFormat`

Parameter Details

<basedir>

Base directory of the project.

Type: java.io.File
Required: No
User Property: coveralls.basedir
Default: ${project.basedir}

<branch>

Git branch name.

Type: java.lang.String
Required: No
User Property: branch

<cloverReports>

File paths to additional Clover coverage report files.

Type: java.util.List<java.io.File>
Required: No
User Property: cloverReports

<coberturaReports>

Deprecated.
Cobertura is deprecated and no longer maintained. Use JaCoCo instead.

File paths to additional Cobertura coverage report files.

Coveralls Maven Plugin 4.5.0 is last to work with Cobertura as java 8 required.

Type: java.util.List<java.io.File>
Required: No
User Property: coberturaReports

<coverallsFile>

File path to write and submit Coveralls data.

Type: java.io.File
Required: No
User Property: coverallsFile
Default: ${project.build.directory}/coveralls.json

<coverallsUrl>

Url for the Coveralls API.

Type: java.lang.String
Required: No
User Property: coverallsUrl
Default: https://coveralls.io/api/v1/jobs

<dryRun>

Dry run Coveralls report without actually sending it.

Type: boolean
Required: No
User Property: dryRun
Default: false

<failOnServiceError>

Fail build if Coveralls service is not available or submission fails for internal errors.

Type: boolean
Required: No
User Property: failOnServiceError
Default: true

<jacocoAggregateReport>

In a Maven Multi-Module project, it's common to configure JaCoCo with a Maven project that's used for aggregating all JaCoCo reports into a single location. In this circumstance use the "jacocoAggregateReport" property so that only this location is used for coverage rather than looking for JaCoCo reports in each Maven project.

Type: java.io.File
Since: 5.0.0
Required: No
User Property: jacocoAggregateReport

<jacocoReports>

File paths to additional JaCoCo coverage report files.

By default, this plugin will look for a files in the standard JaCoCo locations. If a merged report is found in

${project.reporting.outputDirectory}/jacoco-merged-report/jacoco.xml

then it will be used. Otherwise, the plugin will fallback to looking for files in both

${project.reporting.outputDirectory}/jacoco/jacoco.xml

and

${project.reporting.outputDirectory}/jacoco-it/jacoco.xml

If the "jacocoAggregateReport" property is set then this property will be ignored

Type: java.util.List<java.io.File>
Required: No
User Property: jacocoReports

<parallel>

Coveralls parallel flag.

Type: boolean
Required: No
User Property: parallel

<pullRequest>

GitHub pull request identifier.

Type: java.lang.String
Required: No
User Property: pullRequest

<relativeReportDirs>

Directories for relative per module specific report files.

Type: java.util.List<java.lang.String>
Required: No
User Property: relativeReportDirs

<repoToken>

Coveralls repository token.

Type: java.lang.String
Required: No
User Property: repoToken

<sagaReports>

File paths to additional Saga coverage report files.

Type: java.util.List<java.io.File>
Required: No
User Property: sagaReports

<scanForSources>

Scan subdirectories for source files.

Type: boolean
Required: No
User Property: scanForSources
Default: false

<serviceBuildNumber>

CI service build number.

Type: java.lang.String
Required: No
User Property: serviceBuildNumber

<serviceBuildUrl>

CI service build url.

Type: java.lang.String
Required: No
User Property: serviceBuildUrl

<serviceEnvironment>

CI service specific environment properties.

Type: java.util.Properties
Required: No
User Property: serviceEnvironment

<serviceJobId>

CI service job id.

Type: java.lang.String
Required: No
User Property: serviceJobId

<serviceName>

CI service name.

Type: java.lang.String
Required: No
User Property: serviceName

<skip>

Skip the plugin execution.

Type: boolean
Required: No
User Property: coveralls.skip
Default: false

<sourceDirectories>

Source directories.

Type: java.util.List<java.io.File>
Required: No
User Property: sourceDirectories

<sourceEncoding>

Source file encoding.

Type: java.lang.String
Required: No
User Property: sourceEncoding
Default: ${project.build.sourceEncoding}

<timestamp>

Build timestamp. Must be in format defined by 'timestampFormat' if it's available or in default timestamp format yyyy-MM-dd'T'HH:mm:ss'Z'.

Type: java.lang.String
Required: No
User Property: timestamp
Default: ${maven.build.timestamp}

<timestampFormat>

Build timestamp format. Must be in format supported by DateTimeFormatter.

Type: java.lang.String
Required: No
User Property: timestampFormat
Default: ${maven.build.timestamp.format}