Skip to content

Commit 73b4010

Browse files
committed
[MPMD-379] Improve upgrading notes
1 parent ed944d5 commit 73b4010

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ Upgrading PMD at Runtime
8585

8686
Here's a historical overview about the default PMD version used:
8787

88-
*--------------------------------------------------------------------------------*--------------------------------------------------*
89-
| <<maven-pmd-plugin>> | <<PMD>> |
90-
*--------------------------------------------------------------------------------*--------------------------------------------------*
91-
| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.22.0/}3.22.0}} | {{{https://pmd.github.io/pmd-7.0.0/}7.0.0}} |
92-
*--------------------------------------------------------------------------------*--------------------------------------------------*
88+
*--------------------------------------------------------------------------------*-----------------------------------------------------*
89+
| <<maven-pmd-plugin>> | <<PMD>> |
90+
*--------------------------------------------------------------------------------*-----------------------------------------------------*
91+
| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.22.0/}3.22.0}} | {{{https://docs.pmd-code.org/pmd-doc-7.0.0/}7.0.0}} |
92+
*--------------------------------------------------------------------------------*-----------------------------------------------------*
9393
| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.21.0/}3.21.0}} | {{{https://pmd.github.io/pmd-6.55.0/}6.55.0}} |
9494
*--------------------------------------------------------------------------------*--------------------------------------------------*
9595
| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.20.0/}3.20.0}} | {{{https://pmd.github.io/pmd-6.53.0/}6.53.0}} |

src/site/apt/index.apt.vm

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,30 @@ ${project.name}
8989

9090
* Upgrading Notes
9191

92-
<<Note:>> Starting with Maven PMD Plugin 3.22.0, the plugin requires PDM version 7.0.0 or higher.
93-
The PMD 7.0.0 switched to the SLF4J and since Maven 3.1.0+ the SLF4J is the default logging API,
94-
because of that the <<<showPmdLog>>> makes no sense to exist. See
95-
{{{}https://maven.apache.org/ref/3.9.6/maven-embedder/logging.html}}Maven Logging for more details.
96-
97-
<<Note:>> Starting with PMD 6.0.0 and Maven PMD Plugin 3.9.0, the rules have been reorganized
98-
into categories, e.g. <<</category/java/bestpractices.xml>>>. So when upgrading to
99-
Maven PMD Plugin 3.9.0 you should review your plugin configuration and/or custom ruleset.
100-
See {{{./examples/usingRuleSets.html}Using Rule Sets}} for more information.
92+
** 3.22.0
93+
94+
* Starting with Maven PMD Plugin 3.22.0, the plugin requires PMD version 7.0.0 or higher.
95+
PMD 7.0.0 switched to SLF4J and since Maven 3.1.0+ SLF4J is the default logging API.
96+
Logs from PMD are now always shown and cannot be disabled at runtime after maven has started.
97+
The property <<<showPmdLog>>> makes no sense anymore and is deprecated now. See
98+
{{{https://maven.apache.org/maven-logging.html}Maven Logging}} for how to configure logging.
99+
For disabling PMD logs, you'd need to start maven with <<<MAVEN_OPTS=-Dorg.slf4j.simpleLogger.log.net.sourceforge.pmd=off mvn <goals>>>>.
100+
101+
* The upgrade from PMD 6 to PMD 7.0.0 is a major version change. If you use the default ruleset
102+
from Maven PMD Plugin, then everything should just work. But if you use a custom ruleset, you
103+
most likely need to review your ruleset and migrate it to PMD 7. Rules might have been renamed or
104+
replaced. See {{{https://docs.pmd-code.org/latest/pmd_release_notes_pmd7.html}Detailed Release Notes for PMD 7}}
105+
and {{{https://docs.pmd-code.org/latest/pmd_userdocs_migrating_to_pmd7.html}Migration Guide for PMD 7}}.
106+
107+
* If you currently override the dependency to PMD ({{{./examples/upgrading-PMD-at-runtime.html}Upgrading PMD at Runtime}})
108+
make sure to upgrade PMD as well to 7.0.0 or later when upgrading the Maven PMD Plugin.
109+
110+
** 3.9.0
111+
112+
* Starting with PMD 6.0.0 and Maven PMD Plugin 3.9.0, the rules have been reorganized
113+
into categories, e.g. <<</category/java/bestpractices.xml>>>. So when upgrading to
114+
Maven PMD Plugin 3.9.0 you should review your plugin configuration and/or custom ruleset.
115+
See {{{./examples/usingRuleSets.html}Using Rule Sets}} for more information.
101116

102117

103118
* Examples

0 commit comments

Comments
 (0)