带有许可插件的Maven多模块项目

时间:2013-01-13 18:08:06

标签: maven pom.xml multi-module project-structure

我有一个多模块project,我正在尝试设置许可插件来管理所有许可。这是项目设置:

─── transfuse-project
    ├── examples
    │   ├── helloAndroid
    │   │   ├── pom.xml
    │   │   ├── ...
    │   ├── integrationTest
    │   │   ├── pom.xml
    │   │   ├── ...
    │   ├── pom.xml
    │   └── ...
    ├── transfuse
    │   ├── pom.xml
    │   ├── ...
    ├── transfuse-api
    │   ├── pom.xml
    │   ├── ...
    ├── NOTICE
    └── pom.xml

每个pom.xml都继承自transfuse-project pom.xml。在项目pom.xml中,我设置了许可插件以将NOTICE应用于相关文件:

        <plugin>
            <groupId>com.mycila.maven-license-plugin</groupId>
            <artifactId>maven-license-plugin</artifactId>
            <version>1.9.0</version>
            <configuration>
                <header>NOTICE</header>
                <includes>
                    <include>**/*.java</include>
                    <include>**/*.xml</include>
                </includes>
                <excludes>
                    <exclude>**/.*/**</exclude>
                    <exclude>target/**</exclude>
                    <exclude>**/AndroidManifest.xml</exclude>
                </excludes>
                <properties>
                    <year>2013</year>
                    <name>John Ericksen</name>
                </properties>
                <useDefaultExcludes>true</useDefaultExcludes>
                <strictCheck>true</strictCheck>
            </configuration>
            <executions>
                <execution>
                    <id>check-headers</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

如果我直接在root(transfuse-project)之外构建,则此配置有效。当我直接构建integrationTest示例或api时出现问题。 Maven找不到我在项目根目录中提供的NOTICE文件:

[ERROR] Failed to execute goal com.mycila.maven-license-plugin:maven-license-plugin:1.9.0:check (check-headers) on project transfuse-api: Some files do not have the expected license header -> [Help 1]

更糟糕的是,它找到了另一个依赖项的NOTICE文件。如果我在子模块中运行mvn license:format,它会用依赖项的NOTICE文件替换所有模块的头文件。

我相信我可以在每个子模块中添加NOTICE文件来修复此问题,并使用自己的许可插件配置每个子模块pom,但我想尽可能避免重复。是否有一些配置或设置可用于我的项目设置?

3 个答案:

答案 0 :(得分:1)

尝试使用

使用绝对路径
<header>${basedir}/NOTICE</header>

如果这不起作用,请尝试set a property to and in the parent module's basedir并使用它:

<header>${main.basedir}/NOTICE</header>

第三个选项是在运行时设置属性:

mvn clean install -Dmain.basedir=path/to/main/basedir

修改

好的,另一个选择是在许可插件之前执行maven-dependency-plugin。但您必须确保父母附上通知(使用maven-assembly-plugin plugin

<plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>
         <version>2.6</version>
         <executions>
           <execution>
             <id>unpack-parent</id>
             <phase>verify</phase>
             <goals>
               <goal>unpack</goal>
             </goals>
             <configuration>
               <artifactItems>
                 <artifactItem>
                   <groupId>parent</groupId>
                   <artifactId>parent</artifactId>
                   <version>parent</version>
                   <type>pom</type>
                   <overWrite>false</overWrite>
                   <outputDirectory>${project.build.directory}/license</outputDirectory>
                   <includes>NOTICE</includes>
                 </artifactItem>
               </artifactItems>
             </configuration>
           </execution>
         </executions>
       </plugin>

然后header发生了变化:

<header>${project.build.directory}/license/NOTICE</header>

<强> EDIT2:

我遇到了find-maven-plugin。我认为这可行:

<plugin>
    <groupId>com.github.goldin</groupId>
    <artifactId>find-maven-plugin</artifactId>
    <version>0.2.5</version>
    <executions>
        <execution>
            <id>find-notice-file</id>
            <goals>
                <goal>find</goal>
            </goals>
            <phase>validate</phase>
            <configuration>
                <propertyName>notice.file</propertyName>
                <file>NOTICE</file>
            </configuration>
        </execution>
    </executions>
</plugin>

答案 1 :(得分:1)

实际上有一种更简单的方法可以做到这一点。只需在配置中将aggregate标记设置为true即可。这是完整的maven-license-plugin定义:

<plugin>
    <groupId>com.mycila.maven-license-plugin</groupId>
    <artifactId>maven-license-plugin</artifactId>
    <version>1.10.b1</version>
    <configuration>
        <header>etc/header.txt</header>
        <aggregate>true</aggregate>
        <includes>
            <include>**/*.java</include>
        </includes>
    </configuration>
</plugin>

然后,您只需要在父根目录中的header.txt中有一个名为etc/header.txt的文件。

答案 2 :(得分:0)

尝试使用这两个配置属性集的示例:

<plugin>
  <groupId>com.mycila</groupId>
  <artifactId>license-maven-plugin</artifactId>
  <version>2.7</version>
  <configuration>
    <header>/NOTICE</header>
    <aggregate>true</aggregate>
  </configuration>
</plugin>