Built by Maven

pmd:aggregate-cpd-check

Full name:

org.apache.maven.plugins:maven-pmd-plugin:3.26.0:aggregate-cpd-check

Description:

Fail the build in an aggregator project if there were any CPD violations in the source code.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 3.15.0.
  • Binds by default to the lifecycle phase: verify.
  • Invokes the execution of the following plugin's goal prior to executing itself: aggregate-cpd.

Required Parameters

Name Type Since Description
<failOnViolation> boolean 3.0 Whether to fail the build if the validation check fails.
Default: true
User Property: cpd.failOnViolation
<targetDirectory> File - The location of the XML report to check, as generated by the PMD report.
User Property: project.build.directory

Optional Parameters

Name Type Since Description
<aggregate> boolean 2.2
Deprecated.
since 3.15.0 Use the goal pmd:aggregate-check or pmd:aggregate-cpd-check instead.

Whether to build an aggregated report at the root, or build individual reports.
Default: false
User Property: aggregate
<excludeFromFailureFile> String 3.0 File that lists classes and rules to be excluded from failures. For PMD, this is a properties file. For CPD, this is a text file that contains comma-separated lists of classes that are allowed to duplicate.
User Property: pmd.excludeFromFailureFile
<maxAllowedViolations> int 3.10.0 The maximum number of failures allowed before execution fails. Used in conjunction with failOnViolation=true and utilizes failurePriority. This value has no meaning if failOnViolation=false. If the number of failures is greater than this number, the build will be failed. If the number of failures is less than or equal to this value, then the build will not be failed.
Default: 0
User Property: pmd.maxAllowedViolations
<printFailingErrors> boolean 3.0 Print details of errors that cause build failure
Default: false
User Property: pmd.printFailingErrors
<skip> boolean - Skip the CPD violation checks. Most useful on the command line via "-Dcpd.skip=true".
Default: false
User Property: cpd.skip
<verbose> boolean - Print details of check failures to build output.
Default: false
User Property: pmd.verbose

Parameter Details

<aggregate>

Deprecated.
since 3.15.0 Use the goal pmd:aggregate-check or pmd:aggregate-cpd-check instead.

Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: aggregate
  • Default: false

<excludeFromFailureFile>

File that lists classes and rules to be excluded from failures. For PMD, this is a properties file. For CPD, this is a text file that contains comma-separated lists of classes that are allowed to duplicate.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: pmd.excludeFromFailureFile

<failOnViolation>

Whether to fail the build if the validation check fails.
  • Type: boolean
  • Since: 3.0
  • Required: Yes
  • User Property: cpd.failOnViolation
  • Default: true

<maxAllowedViolations>

The maximum number of failures allowed before execution fails. Used in conjunction with failOnViolation=true and utilizes failurePriority. This value has no meaning if failOnViolation=false. If the number of failures is greater than this number, the build will be failed. If the number of failures is less than or equal to this value, then the build will not be failed.
  • Type: int
  • Since: 3.10.0
  • Required: No
  • User Property: pmd.maxAllowedViolations
  • Default: 0

<printFailingErrors>

Print details of errors that cause build failure
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: pmd.printFailingErrors
  • Default: false

<skip>

Skip the CPD violation checks. Most useful on the command line via "-Dcpd.skip=true".
  • Type: boolean
  • Required: No
  • User Property: cpd.skip
  • Default: false

<targetDirectory>

The location of the XML report to check, as generated by the PMD report.
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory

<verbose>

Print details of check failures to build output.
  • Type: boolean
  • Required: No
  • User Property: pmd.verbose
  • Default: false