Author: gboue
Date: Tue Nov 29 23:31:33 2016
New Revision: 1771979

URL: http://svn.apache.org/viewvc?rev=1771979&view=rev
Log:
[MENFORCER-259] The rule BanDuplicatePomDependencyVersions is not documented

Adding banDuplicatePomDependencyVersions, introduced in MENFORCER-152, to the 
documentation.

Added:
    
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
   (with props)
Modified:
    maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt

Added: 
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
URL: 
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm?rev=1771979&view=auto
==============================================================================
--- 
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
 (added)
+++ 
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
 Tue Nov 29 23:31:33 2016
@@ -0,0 +1,67 @@
+~~ 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.    
+ 
+  ------
+  Ban Duplicate Pom Dependency Versions
+  ------
+  Guillaume Boue
+  ------
+  November 2016
+  ------
+
+Ban Duplicate Pom Dependency Versions
+
+  This rule checks that there are no duplicate dependencies declared in the 
POM of the project.
+  Duplicate dependencies are dependencies which have the same group id, 
artifact id, type and classifier.
+
+  The following parameters are supported by this rule:
+   
+  * message - an optional supplemental message to the user if the rule fails.
+
+   []
+
+   
+  Sample Plugin Configuration:
+  
++------+
+<project>
+  [...]
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-enforcer-plugin</artifactId>
+        <version>${project.version}</version>
+        <executions>
+          <execution>
+            <id>no-duplicate-declared-dependencies</id>
+            <goals>
+              <goal>enforce</goal>
+            </goals>
+            <configuration>
+              <rules>
+                <banDuplicatePomDependencyVersions/>
+              </rules>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+  [...]
+</project>
++-------+

Propchange: 
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: 
maven/enforcer/trunk/enforcer-rules/src/site/apt/banDuplicatePomDependencyVersions.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt
URL: 
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt?rev=1771979&r1=1771978&r2=1771979&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt (original)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt Tue Nov 29 
23:31:33 2016
@@ -32,7 +32,9 @@ Standard Rules
   * {{{./alwaysPass.html}alwaysPass}} - Always passes... used to test plugin 
configuration.
   
   * {{{./banDistributionManagement.html}banDistributionManagement}} - enforces 
that project doesn't have distributionManagement.
-
+  
+  * 
{{{./banDuplicatePomDependencyVersions.html}banDuplicatePomDependencyVersions}} 
- enforces that the project doesn't have duplicate declared dependencies.
+  
   * {{{./bannedDependencies.html}bannedDependencies}} - enforces that excluded 
dependencies aren't included.
   
   * {{{./bannedPlugins.html}bannedPlugins}} - enforces that specific plugins 
aren't included in the build.


Reply via email to