~ubuntu-branches/ubuntu/saucy/maven-enforcer/saucy

« back to all changes in this revision

Viewing changes to enforcer-rules/src/site/apt/requireReleaseDeps.apt

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-09-12 22:30:16 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: package-import@ubuntu.com-20110912223016-e2pk04avoq8bur7t
Tags: 1.0-1
* Team upload
* New upstream release.
* Add more Build-Depends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
~~ Licensed to the Apache Software Foundation (ASF) under one
2
 
~~ or more contributor license agreements.  See the NOTICE file
3
 
~~ distributed with this work for additional information
4
 
~~ regarding copyright ownership.  The ASF licenses this file
5
 
~~ to you under the Apache License, Version 2.0 (the
6
 
~~ "License"); you may not use this file except in compliance
7
 
~~ with the License.  You may obtain a copy of the License at
8
 
~~
9
 
~~ http://www.apache.org/licenses/LICENSE-2.0
10
 
~~
11
 
~~ Unless required by applicable law or agreed to in writing,
12
 
~~ software distributed under the License is distributed on an
13
 
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
 
~~ KIND, either express or implied.  See the License for the
15
 
~~ specific language governing permissions and limitations
16
 
~~ under the License.    
17
 
 
18
 
  ------
19
 
  Require Release Dependencies
20
 
  ------
21
 
  Brian Fox
22
 
  ------
23
 
  Auguest 2008
24
 
  ------
25
 
 
26
 
Require Release Dependencies
27
 
 
28
 
  This rule checks the dependencies and fails if any snapshots are found.
29
 
 
30
 
 
31
 
   The following parameters are supported by this rule:
32
 
   
33
 
   * searchTransitive - if transitive dependencies should be checked. Default: true
34
 
   
35
 
   * message - an optional message to the user if the rule fails.
36
 
   
37
 
   * onlyWhenRelease - if this rule should only be executed when the version is a non-SNAPSHOT version. Default: false
38
 
   
39
 
   * failWhenParentIsSnapshot - if the parent should be checked. Default: true 
40
 
 
41
 
   []
42
 
 
43
 
   
44
 
  Sample Plugin Configuration:
45
 
  
46
 
+---+
47
 
<project>
48
 
  [...]
49
 
  <build>
50
 
    <plugins>
51
 
      <plugin>
52
 
        <groupId>org.apache.maven.plugins</groupId>
53
 
        <artifactId>maven-enforcer-plugin</artifactId>
54
 
        <version>1.0</version>
55
 
        <executions>
56
 
          <execution>
57
 
            <id>enforce-no-snapshots</id>
58
 
            <goals>
59
 
              <goal>enforce</goal>
60
 
            </goals>
61
 
            <configuration>
62
 
              <rules>
63
 
                <requireReleaseDeps>
64
 
                  <message>No Snapshots Allowed!</message>
65
 
                </requireReleaseDeps>
66
 
              </rules>
67
 
              <fail>true</fail>
68
 
            </configuration>
69
 
          </execution>
70
 
        </executions>
71
 
      </plugin>
72
 
    </plugins>
73
 
  </build>
74
 
  [...]
75
 
</project>
76
 
+---+
77