maven-enforcer/enforcer-rules/src/site/apt/requireFilesExist.apt.vm at 01570d47cabafb0c7978ee0be41b2bb80f6eae05 · apache/maven-enforcer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
~~ 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
  ------
  2008-08-06
  ------

Require Files Exist

  This rule checks that the specified list of files exist.

  The mounted filesystem(s) will dictate the case-sensitive rules when checking files. If you require checks that your
  filesystem(s) do not support (e.g. a case-sensitive check on a case-insensitive filesystem) then you should consider
  adding your own custom plugin that meets your specific needs.

   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.

   * <<allowNulls>> - If null files should be allowed. If allowed, they will be treated as if they do exist. Default is false.

   * <<satisfyAny>> - Allows that one of files can make the rule pass, instead of all the files. Default is false.

   []


  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-files-exist</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <requireFilesExist>
                  <files>
                   <file>\${project.build.outputDirectory}/foo.txt</file>
                   <file>\${project.build.outputDirectory}/foo2.txt</file>
                  </files>
                </requireFilesExist>
              </rules>
              <fail>true</fail>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  [...]
</project>
+---+