Author: brianf
Date: Tue Aug 5 18:09:24 2008
New Revision: 683072
URL: http://svn.apache.org/viewvc?rev=683072&view=rev
Log:
updated site docs
Added:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesSize.java
- copied, changed from r683029,
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFileSize.java
maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysFail.apt
maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysPass.apt
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesDontExist.apt
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesExist.apt
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesSize.apt
Removed:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFileSize.java
Modified:
maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireReleaseVersion.apt
maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/index.apt
Copied:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesSize.java
(from r683029,
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFileSize.java)
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesSize.java?p2=maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesSize.java&p1=maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFileSize.java&r1=683029&r2=683072&rev=683072&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFileSize.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireFilesSize.java
Tue Aug 5 18:09:24 2008
@@ -33,7 +33,7 @@
* @author brianf
* @author Roman Stumm
*/
-public class RequireFileSize
+public class RequireFilesSize
extends AbstractRequireFiles
{
Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysFail.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysFail.apt?rev=683072&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysFail.apt (added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysFail.apt Tue Aug 5
18:09:24 2008
@@ -0,0 +1,61 @@
+~~ 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.
+
+ ------
+ Always Fail
+ ------
+ Brian Fox
+ ------
+ August 2008
+ ------
+
+Always Fail
+
+ This rule will always fail. It is useful for testing proper plugin
configuration.
+
+
+ Sample Plugin Configuration:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <id>enforce</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <AlwaysFail/>
+ </rules>
+ <fail>true</fail>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysPass.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysPass.apt?rev=683072&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysPass.apt (added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/alwaysPass.apt Tue Aug 5
18:09:24 2008
@@ -0,0 +1,61 @@
+~~ 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.
+
+ ------
+ AlwaysPass
+ ------
+ Brian Fox
+ ------
+ August 2008
+ ------
+
+Always Pass
+
+ This rule will always succeed. It is useful for testing proper plugin
configuration.
+
+
+ Sample Plugin Configuration:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <id>enforce-no-snapshots</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <AlwaysPass/>
+ </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=683072&r1=683071&r2=683072&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt (original)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt Tue Aug 5
18:09:24 2008
@@ -20,19 +20,25 @@
------
Brian Fox
------
- June 2007
+ August 2008
------
Standard Rules
The following standard rules ship along with the enforcer plugin:
+ * {{{./alwaysPass.html}alwaysPass}} - Always passes... used to test plugin
configuration.
+
+ * {{{./alwaysFail.html}alwaysFail}} - Always fail... used to test plugin
configuration.
+
* {{{./bannedDependencies.html}bannedDependencies}} - enforces that excluded
dependencies aren't included.
* {{{./evaluateBeanshell.html}evaluateBeanshell}} - evaluates a beanshell
script.
* {{{./requireReleaseDeps.html}requireReleaseDeps}} - enforces that no
snapshots are included as dependencies.
+ * {{{./requireReleaseVersion.html}requireReleaseVersion}} - enforces that
the artifact is not a snapshot.
+
* {{{./requireMavenVersion.html}requireMavenVersion}} - enforces the Maven
version.
* {{{./requireJavaVersion.html}requireJavaVersion}} - enforces the JDK
version.
@@ -42,6 +48,12 @@
* {{{./requirePluginVersions.html}requirePluginVersions}} - enforces that
all plugins have a specified version.
* {{{./requireProperty.html}requireProperty}} - enforces the existence and
values of properties.
+
+ * {{{./requireFilesDontExist.html}requireFilesDontExist}} - enforces that
the list of files do not exist.
+
+ * {{{./requireFilesExist.html}requireFilesExist}} - enforces that the list
of files do exist.
+
+ * {{{./requireFilesSize.html}requireFilesSize}} - enforces that the list of
files exist and are within a certain size range.
[]
Added:
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesDontExist.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesDontExist.apt?rev=683072&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesDontExist.apt
(added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesDontExist.apt
Tue Aug 5 18:09:24 2008
@@ -0,0 +1,74 @@
+~~ 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.
+
+ ------
+ Require Files Dont Exist
+ ------
+ Brian Fox
+ ------
+ August 2008
+ ------
+
+Require Files Exist
+
+ This rule checks that the specified list of files do not exist.
+
+
+ The following parameters are supported by this rule:
+
+ * message - an optional message to the user if the rule fails.
+ * files - A list of files to check.
+
+ []
+
+
+ Sample Plugin Configuration:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <id>enforce-dont-exist</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <requireFilesDontExist>
+ <files>
+ <file>${project.outputDirectory}/foo.txt</file>
+ <file>${project.outputDirectory}/foo2.txt</file>
+ </files>
+ </requireFilesDontExist>
+ </rules>
+ <fail>true</fail>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesExist.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesExist.apt?rev=683072&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesExist.apt
(added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesExist.apt Tue
Aug 5 18:09:24 2008
@@ -0,0 +1,74 @@
+~~ 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.
+
+ ------
+ Require Files Exist
+ ------
+ Brian Fox
+ ------
+ August 2008
+ ------
+
+Require Files Exist
+
+ This rule checks that the specified list of files exist.
+
+
+ The following parameters are supported by this rule:
+
+ * message - an optional message to the user if the rule fails.
+ * files - A list of files to check.
+
+ []
+
+
+ Sample Plugin Configuration:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <id>enforce-no-snapshots</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <requireFilesExist>
+ <files>
+ <file>${project.outputDirectory}/foo.txt</file>
+ <file>${project.outputDirectory}/foo2.txt</file>
+ </files>
+ </requireFilesExist>
+ </rules>
+ <fail>true</fail>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesSize.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesSize.apt?rev=683072&view=auto
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesSize.apt
(added)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/requireFilesSize.apt Tue
Aug 5 18:09:24 2008
@@ -0,0 +1,78 @@
+~~ 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.
+
+ ------
+ Require File Size
+ ------
+ Brian Fox
+ ------
+ August 2008
+ ------
+
+Require File Size
+
+ This rule checks that the specified list of files exist and are within the
specified size range.
+
+
+ The following parameters are supported by this rule:
+
+ * message - an optional message to the user if the rule fails.
+ * files - A list of files to check.
+ * maxsize - maximum size in bytes for this file
+ * minsize - minimum size in bytes for this file
+
+ []
+
+
+ Sample Plugin Configuration:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <id>enforce-no-snapshots</id>
+ <goals>
+ <goal>enforce</goal>
+ </goals>
+ <configuration>
+ <rules>
+ <requireFilesSize>
+ <maxSize>10000</maxSize>
+ <minSize>90</minsize>
+ <files>
+ <file>${project.outputDirectory}/foo.txt</file>
+ <file>${project.outputDirectory}/foo2.txt</file>
+ </files>
+ </requireFilesSize>
+ </rules>
+ <fail>true</fail>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
Modified:
maven/enforcer/trunk/enforcer-rules/src/site/apt/requireReleaseVersion.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/requireReleaseVersion.apt?rev=683072&r1=683071&r2=683072&view=diff
==============================================================================
--- maven/enforcer/trunk/enforcer-rules/src/site/apt/requireReleaseVersion.apt
(original)
+++ maven/enforcer/trunk/enforcer-rules/src/site/apt/requireReleaseVersion.apt
Tue Aug 5 18:09:24 2008
@@ -16,11 +16,11 @@
~~ under the License.
------
- Require Release Dependencies
+ Require Release Version
------
Brian Fox
------
- November 2007
+ August 2008
------
Require Release Dependencies
Modified: maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/index.apt?rev=683072&r1=683071&r2=683072&view=diff
==============================================================================
--- maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/index.apt (original)
+++ maven/enforcer/trunk/maven-enforcer-plugin/src/site/apt/index.apt Tue Aug
5 18:09:24 2008
@@ -25,16 +25,14 @@
Maven Enforcer Plugin - The Loving Iron Fist of Maven\x99
- The Enforcer plugin provides goals to control certain environmental
constraints such as Maven version, JDK version and OS family.
+ The Enforcer plugin provides goals to control certain environmental
constraints such as Maven version, JDK version and OS family along with many
more standard rules and user created rules.
* Goals Overview
- The Enforcer plugin has three goals:
+ The Enforcer plugin has two goals:
*{{{enforce-mojo.html}enforcer:enforce}} executes rules for each project in
a multi-project build.
- *{{{enforce-once-mojo.html}enforcer:enforce-once}} executes rules once per
build.
-
*{{{display-info-mojo.html}enforcer:display-info}} display the current
information as detected by the standard rules.
* Usage
