Author: adangel
Date: Sat Aug 19 09:19:07 2017
New Revision: 1805494
URL: http://svn.apache.org/viewvc?rev=1805494&view=rev
Log:
[MPMD-239] Add documentation about upgrading PMD version at runtime
Added:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm?rev=1805494&view=auto
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm
(added)
+++
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/upgrading-PMD-at-runtime.apt.vm
Sat Aug 19 09:19:07 2017
@@ -0,0 +1,79 @@
+ ------
+ Upgrading PMD at Runtime
+ ------
+ Andreas Dangel
+ ------
+ 2017-08-19
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Upgrading PMD at Runtime
+
+ The Maven PMD plugin comes with a default PMD version: for
<<<maven-pmd-plugin ${project.version}>>>,
+ PMD ${pmdVersion} is used by default.
+
+ Given that the {{{https://pmd.github.io}newer PMD version}} is compatible,
+ you can override the PMD version, that the Maven plugin will use and benefit
+ from the latest bugfixes and enhancements:
+
++-----+
+<project>
+ <properties>
+ <pmdVersion>...choose your version...</version>
+ </properties>
+...
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <version>${project.version}</version>
+ <dependencies>
+ <dependency>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-core</artifactId>
+ <version>\${pmdVersion}</version>
+ </dependency>
+ <dependency>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-java</artifactId>
+ <version>\${pmdVersion}</version>
+ </dependency>
+ <dependency>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-javascript</artifactId>
+ <version>\${pmdVersion}</version>
+ </dependency>
+ <dependency>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-jsp</artifactId>
+ <version>\${pmdVersion}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+...
+</project>
++-----+
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm?rev=1805494&r1=1805493&r2=1805494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt.vm Sat Aug 19
09:19:07 2017
@@ -73,6 +73,8 @@ ${project.name}
To provide you with better understanding of some usages of the Maven PMD
Plugin, you can take a look into the
following examples:
+ * {{{./examples/upgrading-PMD-at-runtime.html}Upgrading PMD at Runtime}}
+
* {{{./examples/multi-module-config.html}Multimodule Configuration}}
* {{{./examples/removeReport.html}Remove Report}}
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml?rev=1805494&r1=1805493&r2=1805494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/site.xml Sat Aug 19 09:19:07
2017
@@ -33,6 +33,7 @@ under the License.
<item name="Download" href="download.html"/>
</menu>
<menu name="Examples">
+ <item name="Upgrading PMD at Runtime"
href="examples/upgrading-PMD-at-runtime.html"/>
<item name="Multimodule Configuration"
href="examples/multi-module-config.html"/>
<item name="Remove Report" href="examples/removeReport.html"/>
<item name="Target JDK" href="examples/targetJdk.html"/>
