Author: khmarbaise Date: Tue Jan 7 11:22:24 2014 New Revision: 1556182 URL: http://svn.apache.org/r1556182 Log: [MENFORCER-171] - Added documentation for requireEnvironmentVariable and fixed link from index page.
Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/requireEnvironmentVariable.apt.vm Modified: maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt 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=1556182&r1=1556181&r2=1556182&view=diff ============================================================================== --- maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt (original) +++ maven/enforcer/trunk/enforcer-rules/src/site/apt/index.apt Tue Jan 7 11:22:24 2014 @@ -43,7 +43,7 @@ Standard Rules * requireActiveProfile - enforces one or more active profiles. - * requireEnvironmentVariable - enforces the existence of an environment variable + * {{{./requireEnvironmentVariable .html}requireEnvironmentVariable}} - enforces the existence of an environment variable * {{{./requireFilesDontExist.html}requireFilesDontExist}} - enforces that the list of files do not exist. Added: maven/enforcer/trunk/enforcer-rules/src/site/apt/requireEnvironmentVariable.apt.vm URL: http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/site/apt/requireEnvironmentVariable.apt.vm?rev=1556182&view=auto ============================================================================== --- maven/enforcer/trunk/enforcer-rules/src/site/apt/requireEnvironmentVariable.apt.vm (added) +++ maven/enforcer/trunk/enforcer-rules/src/site/apt/requireEnvironmentVariable.apt.vm Tue Jan 7 11:22:24 2014 @@ -0,0 +1,72 @@ +~~ 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 Environment Variable + ------ + Karl-Heinz Marbaise + ------ + December 2013 + ------ + +Require Environment Variable + + This rule checks that a specified environment variable is set. + + + The following parameters are supported by this rule: + + * message - an optional message to the user if the rule fails. + + * variableNames - The name of the environment variable to checkfor. + + [] + + + 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-environment-variable-is-set</id> + <goals> + <goal>enforce</goal> + </goals> + <configuration> + <rules> + <requireEnvironmentVariable> + <variableName>the_name_you_wish_to_be_checked</variablename> + </requireEnvironmentVariable> + </rules> + <fail>true</fail> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + [...] +</project> ++---+