[MPMD-241] - Document the version relationship between plugin and pmd

apache · Jan 19, 2020 · 11634cc · 11634cc
1 parent 3bf0e2b
commit 11634cc
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm b/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm
@@ -77,3 +77,32 @@ Upgrading PMD at Runtime
 ...
 </project>
 +-----+
+
+* Version relationship between maven-pmd-plugin and PMD
+
+   Every maven-pmd-plugin version ships with a default PMD version. The default PMD version
+   is upgraded irregularly, e.g. when support for a newer Java version is required.
+
+   Here's a historical overview about the default PMD version used:
+
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| <<maven-pmd-plugin>>                                                           | <<PMD>>                                          |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.13.0/}3.13.0}} | {{{https://pmd.github.io/pmd-6.19.0/}6.19.0}}    |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.12.0/}3.12.0}} | {{{https://pmd.github.io/pmd-6.13.0/}6.13.0}}    |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.11.0/}3.11.0}} | {{{https://pmd.sourceforge.io/pmd-6.8.0/}6.8.0}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.10.0/}3.10.0}} | {{{https://pmd.sourceforge.io/pmd-6.4.0/}6.4.0}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.9.0/}3.9.0}}   | {{{https://pmd.sourceforge.io/pmd-6.0.1/}6.0.1}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.8/}3.8}}       | {{{https://pmd.sourceforge.io/pmd-5.6.1/}5.6.1}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.7/}3.7}}       | {{{https://pmd.sourceforge.io/pmd-5.5.1/}5.5.1}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.6/}3.6}}       | {{{https://pmd.sourceforge.io/pmd-5.3.5/}5.3.5}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
+| {{{https://maven.apache.org/plugins-archives/maven-pmd-plugin-3.5/}3.5}}       | {{{https://pmd.sourceforge.io/pmd-5.3.2/}5.3.2}} |
+*--------------------------------------------------------------------------------*--------------------------------------------------*
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
@@ -30,6 +30,7 @@ ${project.name}
   Copy/Paste Detector tool (or CPD) distributed with PMD.
 
   This version of Maven PMD Plugin uses PMD ${pmdVersion} and requires Java ${javaVersion}.
+  See {{{./examples/upgrading-PMD-at-runtime.html}Upgrading PMD at Runtime}} for more information.
 
   The plugin accepts configuration parameters that can be used to customize the execution of the PMD tool.