Full name:
org.apache.maven.plugins:maven-pmd-plugin:3.27.0:check
Description:
Fails the build if there were any PMD violations in the source code.
Attributes:
2.0
.verify
.pmd
.<failOnViolation>
boolean
-
Whether to fail the build if the validation check fails. The properties failurePriority
and maxAllowedViolations
control under which conditions exactly the build should be failed.
true
pmd.failOnViolation
<failurePriority>
int
-
What priority level to fail the build on. PMD violations are assigned a priority from 1 (most severe) to 5 (least severe) according to the rule's priority. Violations at or less than this priority level are considered failures and will fail the build if failOnViolation=true
and the count exceeds maxAllowedViolations
. The other violations will be regarded as warnings and will be displayed in the build output if verbose=true
. Setting a value of 5 will treat all violations as failures, which may cause the build to fail. Setting a value of 1 will treat all violations as warnings. Only values from 1 to 5 are valid.
5
pmd.failurePriority
<targetDirectory>
File
-
The location of the XML report to check, as generated by the PMD report.
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.
false
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.
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.
0
pmd.maxAllowedViolations
<printFailingErrors>
boolean
3.0
Print details of errors that cause build failure
false
pmd.printFailingErrors
<skip>
boolean
-
Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true".
false
pmd.skip
<verbose>
boolean
-
Print details of check failures to build output.
false
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.
boolean
2.2
No
aggregate
false
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.
java.lang.String
3.0
No
pmd.excludeFromFailureFile
Whether to fail the build if the validation check fails. The properties failurePriority
and maxAllowedViolations
control under which conditions exactly the build should be failed.
boolean
Yes
pmd.failOnViolation
true
What priority level to fail the build on. PMD violations are assigned a priority from 1 (most severe) to 5 (least severe) according to the rule's priority. Violations at or less than this priority level are considered failures and will fail the build if failOnViolation=true
and the count exceeds maxAllowedViolations
. The other violations will be regarded as warnings and will be displayed in the build output if verbose=true
. Setting a value of 5 will treat all violations as failures, which may cause the build to fail. Setting a value of 1 will treat all violations as warnings. Only values from 1 to 5 are valid.
int
Yes
pmd.failurePriority
5
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.
int
3.10.0
No
pmd.maxAllowedViolations
0
Print details of errors that cause build failure
boolean
3.0
No
pmd.printFailingErrors
false
Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true".
boolean
No
pmd.skip
false
The location of the XML report to check, as generated by the PMD report.
java.io.File
Yes
project.build.directory
Print details of check failures to build output.
boolean
No
pmd.verbose
false
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4