Fork me on GitHub
Built by Maven

spotbugs:spotbugs-aggregate

Note:

This goal should be used as a Maven report.

Full name:

com.github.spotbugs:spotbugs-maven-plugin:4.10.4.1:spotbugs-aggregate

Description:

No description.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

Optional Parameters

Name Type Since Description
<debug> boolean - No description.
Default: false
User Property: spotbugs.debug
<effort> String - No description.
Default: Default
User Property: spotbugs.effort
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean - No description.
Default: false
User Property: spotbugs.skip
<skipEmptyReport> boolean - No description.
Default: false
User Property: spotbugs.skipEmptyReport
<spotbugsXmlOutputFilename> String - No description.
Default: spotbugsXml.xml
User Property: spotbugs.outputXmlFilename
<threshold> String - No description.
Default: Default
User Property: spotbugs.threshold

Parameter Details

<debug>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.debug
  • Default: false

<effort>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.effort
  • Default: Default

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<skip>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.skip
  • Default: false

<skipEmptyReport>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.skipEmptyReport
  • Default: false

<spotbugsXmlOutputFilename>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.outputXmlFilename
  • Default: spotbugsXml.xml

<threshold>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.threshold
  • Default: Default