Built by Maven

coveralls:report

Full name:

com.github.hazendaz.maven:coveralls-maven-plugin:4.5.0-M3:report

Description:

No description.

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
<coberturaReports> List<File> - File paths to additional Cobertura coverage report files.
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
<jacocoReports> List<File> - File paths to additional JaCoCo coverage report files.
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 SimpleDateFormat.
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

<coberturaReports>
File paths to additional Cobertura coverage report files.
  • 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

<jacocoReports>
File paths to additional JaCoCo coverage report files.
  • 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 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 SimpleDateFormat.
  • Type: java.lang.String
  • Required: No
  • User Property: timestampFormat
  • Default: ${maven.build.timestamp.format}