Author: stephenc Date: Thu Sep 23 11:32:10 2010 New Revision: 1000413 URL: http://svn.apache.org/viewvc?rev=1000413&view=rev Log: adding documentation
Added: maven/shared/trunk/maven-plugin-enforcer/src/site/ maven/shared/trunk/maven-plugin-enforcer/src/site/apt/ maven/shared/trunk/maven-plugin-enforcer/src/site/apt/index.apt.vm maven/shared/trunk/maven-plugin-enforcer/src/site/apt/usage.apt.vm maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml (with props) Added: maven/shared/trunk/maven-plugin-enforcer/src/site/apt/index.apt.vm URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-plugin-enforcer/src/site/apt/index.apt.vm?rev=1000413&view=auto ============================================================================== --- maven/shared/trunk/maven-plugin-enforcer/src/site/apt/index.apt.vm (added) +++ maven/shared/trunk/maven-plugin-enforcer/src/site/apt/index.apt.vm Thu Sep 23 11:32:10 2010 @@ -0,0 +1,49 @@ + --- + Introduction + --- + Stephen Connolly + --- + 2010-09-23 + --- + + ~~ 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 + +Maven ${target.maven.version} Plugin Enforcer + + When testing new versions of Maven plugins, it can often be useful + to have a means of forcing a specific maven plugin version be used + irrespective of what is defined in the pom.xml. Maven plugin + developers may also want a CI server to test the new version of their + plugin against third-party source code bases. If the third-party + tree has locked down their plugin versions to non-SNAPSHOT versions + and the CI server is building a -SNAPSHOT version of the plugin, + it can be hard to automate testing the plugin -SNAPSHOTs. + + The Maven ${target.maven.version} Plugin Enforcer provides a means + of forcing maven to use specific versions of plugins that you + specify from the command line overriding any specification in the + pom.xml file. + +* Features + + * Simple command line interface + + * No digging through multiple pom.xml files searching for plugin version lock-down Added: maven/shared/trunk/maven-plugin-enforcer/src/site/apt/usage.apt.vm URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-plugin-enforcer/src/site/apt/usage.apt.vm?rev=1000413&view=auto ============================================================================== --- maven/shared/trunk/maven-plugin-enforcer/src/site/apt/usage.apt.vm (added) +++ maven/shared/trunk/maven-plugin-enforcer/src/site/apt/usage.apt.vm Thu Sep 23 11:32:10 2010 @@ -0,0 +1,111 @@ + --- + Introduction + --- + Stephen Connolly + --- + 2010-09-23 + --- + + ~~ 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 + +Usage + + This page documents how to use the Maven ${target.maven.version} Plugin + Enforcer. + +* Installation + + To install the Maven ${target.maven.version} Plugin Enforcer, you copy + the <<<${project.artifactId}-${project.version}.jar>>> file into the + <<<lib>>> directory of your installation of Maven ${target.maven.version}. + + When the plugin is installed, Maven will print a message on each build after + it has finished scanning for projects, e.g. + ++---+ +$ mvn package +[INFO] Scanning for projects... +[INFO] Plugin Enforcer: Nothing to do (i.e. -Dforce.plugins undefined) +[INFO] +... ++---+ + +* Uninstallation + + To uninstall the Maven ${target.maven.version} Plugin Enforcer, you delete + the <<<${project.artifactId}-${project.version}.jar>>> file from the + <<<lib>>> directory of your installation of Maven ${target.maven.version}. + +* Forcing a specific plugin version + + To force a specific plugin version you just specify the plugin's GAV coordinates + in the force.plugins property from the command line, e.g. to use buildhelper-maven-plugin + version 1.5: + ++---+ +$ mvn -Dforce.plugins=org.codehaus.mojo:buildhelper-maven-plugin:1.5 ... +[INFO] Scanning for projects... +[INFO] ------------------------------------------------------------------------ +[INFO] Plugin Enforcer +[INFO] ------------------------------------------------------------------------ +[INFO] Forcing org.codehaus.mojo:buildhelper-maven-plugin to 1.5 +[INFO] +... ++---+ + + For plugins with a group Id of <<<org.apache.maven.plugins>>> you can omit the group Id, e.g. + ++---+ +$ mvn -Dforce.plugins=maven-surefire-plugin:2.6 ... +[INFO] Scanning for projects... +[INFO] ------------------------------------------------------------------------ +[INFO] Plugin Enforcer +[INFO] ------------------------------------------------------------------------ +[INFO] Forcing org.apache.maven.plugins:maven-surefire-plugin to 2.6 +[INFO] +... ++---+ + + If you want to force multiple plugin versions at the same time, you separate the GAV coordinates + with a comma, e.g. + ++---+ +$ mvn -Dforce.plugins=org.codehaus.mojo:buildhelper-maven-plugin:1.5,maven-surefire-plugin:2.6 ... +[INFO] Scanning for projects... +[INFO] ------------------------------------------------------------------------ +[INFO] Plugin Enforcer +[INFO] ------------------------------------------------------------------------ +[INFO] Forcing org.codehaus.mojo:buildhelper-maven-plugin to 1.5 +[INFO] +[WARNING] No replacements Project: XXX +[INFO] +[INFO] Forcing org.apache.maven.plugins:maven-surefire-plugin to 2.6 +[INFO] +[INFO] Project: XXX +[INFO] Plugin Management: replacing version 2.4.3 with 2.6 +[INFO] Build Plugins: replacing version 2.6 with 2.6 +[INFO] +[INFO] +[INFO] ------------------------------------------------------------------------ +[INFO] Building XXX 1.0-SNAPSHOT +[INFO] ------------------------------------------------------------------------ +... ++---+ Added: maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml?rev=1000413&view=auto ============================================================================== --- maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml (added) +++ maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml Thu Sep 23 11:32:10 2010 @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- +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. +--> +<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"> + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Usage" href="usage.html"/> + </menu> + </body> +</project> + Propchange: maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/shared/trunk/maven-plugin-enforcer/src/site/site.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml