pmd:check

Full name:

org.apache.maven.plugins:maven-pmd-plugin:2.4:check

Description:

Fail the build if there were any PMD violations in the source code.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 2.0.
  • Binds by default to the lifecycle phase: verify.
  • Invokes the execution of this plugin's goal pmd prior to executing itself.

Required Parameters

Name Type Since Description
failOnViolation boolean 2.0 Whether to fail the build if the validation check fails. Default value is: true.
failurePriority int 2.0 What priority level to fail the build on. Failures at or above this level will stop the build. Anything below will be warnings and will be displayed in the build output if verbose=true. Note: Minumum Priority = 5 Maximum Priority = 0 Default value is: 5.
targetDirectory File 2.0 The location of the XML report to check, as generated by the PMD report.

Optional Parameters

Name Type Since Description
aggregate boolean 2.2 Whether to build an aggregated report at the root, or build individual reports. Default value is: false.
skip boolean 2.0 Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true". Default value is: false.
verbose boolean 2.0 Print details of check failures to build output. Default value is: false.

Parameter Details

aggregate :

Whether to build an aggregated report at the root, or build individual reports.

  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${aggregate}
  • Default: false

failOnViolation :

Whether to fail the build if the validation check fails.

  • Type: boolean
  • Since: 2.0
  • Required: Yes
  • Expression: ${pmd.failOnViolation}
  • Default: true

failurePriority :

What priority level to fail the build on. Failures at or above this level will stop the build. Anything below will be warnings and will be displayed in the build output if verbose=true. Note: Minumum Priority = 5 Maximum Priority = 0

  • Type: int
  • Since: 2.0
  • Required: Yes
  • Expression: ${pmd.failurePriority}
  • Default: 5

skip :

Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true".

  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${pmd.skip}
  • Default: false

targetDirectory :

The location of the XML report to check, as generated by the PMD report.

  • Type: java.io.File
  • Since: 2.0
  • Required: Yes
  • Expression: ${project.build.directory}

verbose :

Print details of check failures to build output.

  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${pmd.verbose}
  • Default: false