svn commit: r1412908 - in /maven/enforcer/trunk/enforcer-rules/src/site/apt: bannedPlugins.apt.vm index.apt

[pg...@apache.org]

Author: pgier
Date: Fri Nov 23 15:11:10 2012
New Revision: 1412908

URL: http://svn.apache.org/viewvc?rev=1412908&view=rev
Log:
Add basic site docs for the bannedPlugins rule.

Added:
    maven/enforcer/trunk/enforcer-rules/src/site/apt/bannedPlugins.apt.vm
Modified:
    maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt

Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/bannedPlugins.apt.vm
URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/bannedPlugins.apt.vm?rev=1412908&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/bannedPlugins.apt.vm (added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/bannedPlugins.apt.vm Fri Nov 23 15:11:10 2012
@@ -0,0 +1,87 @@
+~~ 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.    
+ 
+  ------
+  Banned Plugins
+  ------
+  Paul Gier
+  ------
+  November 2012
+  ------
+
+Banned Plugins
+
+   This rule checks the set of plugins used during the build and enforces that specific excluded plugins are not used.
+
+   The following parameters are supported by this rule:
+   
+   * excludes - a list of plugin artifacts to ban. The format is groupId[:artifactId][:version] where artifactId and version are optional. Wildcards may be used to replace an entire section.
+      Examples:
+       
+        * org.apache.maven
+        
+        * org.apache.maven:bad-plugin
+        
+        * org.apache.maven:my-plugin:badVersion
+        
+        * org.apache.maven:*:1.2
+                
+        []
+
+   * includes - a list of plugin artifacts to include. These are exceptions to the excludes. It is meant to allow wide exclusion rules with wildcards and fine tune using includes. 
+     If nothing has been excluded, then the includes have no effect. In otherwords, includes only subtract from artifacts that matched an exclude rule.
+      
+   * message - an optional 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>enforce-banned-dependencies</id>
+            <goals>
+              <goal>enforce</goal>
+            </goals>
+            <configuration>
+              <rules>
+                <bannedPlugins>
+                  <excludes>
+                    <exclude>org.codehaus.mojo:build-helper-maven-plugin</exclude>
+                  </excludes>
+                </bannedPlugins>
+              </rules>
+              <fail>true</fail>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+  [...]
+</project>
++---+

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=1412908&r1=1412907&r2=1412908&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt (original)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt Fri Nov 23 15:11:10 2012
@@ -33,10 +33,10 @@ Standard Rules
  
   * {{{./bannedDependencies.html}bannedDependencies}} - enforces that excluded dependencies aren't included.
   
+  * {{{./bannedPlugins.html}bannedPlugins}} - enforces that specific plugins aren't included in the build.
+  
   * {{{./banTransitiveDependencies.html}banTransitiveDependencies}} - enforces that project doesn't have transitive dependencies.
 
-  * bannedPlugins - enforces that excluded plugins aren't included.
-  
   * {{{./dependencyConvergence.html}dependencyConvergence}} - ensure all dependencies converge to the same version.
 
   * {{{./evaluateBeanshell.html}evaluateBeanshell}} - evaluates a beanshell script.