[GitHub] [maven-pmd-plugin] adangel commented on issue #7: [MPMD-279] Improve documentation of maxAllowedViolations

[GitBox <gi...@apache.org>]

adangel commented on issue #7: [MPMD-279] Improve documentation of maxAllowedViolations
URL: https://github.com/apache/maven-pmd-plugin/pull/7#issuecomment-479990460
 
 
   @jbennett2091 Thanks for your comment.
   I was struggling with the term "issues", since PMD only reports violations (rule violations to be specific). That's why I felt introducing a new generic term does not help but add to the confusion...but I get your point.
   
   In short:
   * Violations: PMD reports violations.
       * Each violation has a priority (1 - high, 2 - medium-high, 3 - medium, 4 - medium-low, 5 - low).
   * Failures: These are violations, with a high enough priority, that we fail the build.
   * Warnings: These are violations, that won't fail the build.
   
   By default, the plugin fails the build for any violation (all violations are failures).
   "failurePriority" configures, which violations are failures and which violations are warnings.
   "maxAllowedViolations" controls, how many failures are needed to fail the build.
   It turns out, that the property "maxAllowedViolations" should have been named actually "maxAllowedFailures", since it only checks the failure count.
   
   I'll try to rephrase the documention with that terminologoy...

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services