pmd/docs/pages/release_notes.md

title	permalink	keywords
PMD Release Notes	pmd_release_notes.html	changelog, release notes

{{ site.pmd.date | date: "%d-%B-%Y" }} - {{ site.pmd.version }}

The PMD team is pleased to announce PMD {{ site.pmd.version }}.

This is a {{ site.pmd.release_type }} release.

{% tocmaker is_release_notes_processor %}

🚀 New and noteworthy

🌟 Rule Changes

Renamed Rules

Several rules for unit testing have been renamed to better reflect their actual scope. Lots of them were called after JUnit / JUnit 4, even when they applied to JUnit 5 and / or TestNG.

• {% rule java/bestpractices/UnitTestAssertionsShouldIncludeMessage %} (Java Best Practices) has been renamed from JUnitAssertionsShouldIncludeMessage.
• {% rule java/bestpractices/UnitTestContainsTooManyAsserts %} (Java Best Practices) has been renamed from JUnitTestContainsTooManyAsserts.
• {% rule java/bestpractices/UnitTestShouldIncludeAssert %} (Java Best Practices) has been renamed from JUnitTestsShouldIncludeAssert.
• {% rule java/bestpractices/UnitTestShouldUseAfterAnnotation %} (Java Best Practices) has been renamed from JUnit4TestShouldUseAfterAnnotation.
• {% rule java/bestpractices/UnitTestShouldUseBeforeAnnotation %} (Java Best Practices) has been renamed from JUnit4TestShouldUseBeforeAnnotation.
• {% rule java/bestpractices/UnitTestShouldUseTestAnnotation %} (Java Best Practices) has been renamed from JUnit4TestShouldUseTestAnnotation.

The old rule names still work but are deprecated.

🐛 Fixed Issues

• java
  • #4532: [java] Rule misnomer for JUnit* rules
• java-bestpractices
  • #4813: [java] SwitchStmtsShouldHaveDefault false positive with pattern matching
• java-errorprone
  • #5067: [java] CloseResource: False positive for FileSystems.getDefault()

🚨 API Changes

• java-bestpractices
  • The old rule name JUnit4TestShouldUseAfterAnnotation has been deprecated. Use the new name {% rule java/bestpractices/UnitTestShouldUseAfterAnnotation %} instead.
  • The old rule name JUnit4TestShouldUseBeforeAnnotation has been deprecated. Use the new name {% rule java/bestpractices/UnitTestShouldUseBeforeAnnotation %} instead.
  • The old rule name JUnit4TestShouldUseTestAnnotation has been deprecated. Use the new name {% rule java/bestpractices/UnitTestShouldUseTestAnnotation %} instead.
  • The old rule name JUnitAssertionsShouldIncludeMessage has been deprecated. Use the new name {% rule java/bestpractices/UnitTestAssertionsShouldIncludeMessage %} instead.
  • The old rule name JUnitTestContainsTooManyAsserts has been deprecated. Use the new name {% rule java/bestpractices/UnitTestContainsTooManyAsserts %} instead.
  • The old rule name JUnitTestsShouldIncludeAssert has been deprecated. Use the new name {% rule java/bestpractices/UnitTestShouldIncludeAssert %} instead.

✨ Merged pull requests

• #4965: [java] Rename JUnit rules with overly restrictive names - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5225: [java] Fix #5067: CloseResource: False positive for FileSystems.getDefault() - Lukas Gräf (@lukasgraef)
• #5241: Ignore javacc code in coverage report - Juan Martín Sotuyo Dodero (@jsotuyod)

{% endtocmaker %}