使用Maven的“仅文档”模块的推荐包装是什么？

Question

我不想在Maven Site工作流程的site文件夹下有多模块Maven项目的文档。文档位于project-docs下project-parent。这种模块的最佳实践packaging是什么？

设置

1. 包装现已配置为jar
2. 在构建工作流程中，有一个Maven插件可以在prepare-package的某个目录（src/main/docs）下的阶段project-docs生成HTML / PDF文档。
3. 有default Maven程序集描述符，可生成project-docs-NNN-default.zip。
4. 项目的默认工件是空 JAR文件。

关于上述（3），备选方案：

包装：pom

不支持prepare-package作为最合适的阶段。如果然后使用阶段site，则无法在默认的install生命周期内生成生成的文档。

包装：jar

空 JAR没用！

Answer 1

由于您不希望将site代用于文档，我认为没有其他＆＃34; maven官方方式＆＃34; 来执行它。

包装

从我的角度来看，你可以使用标准的POM包装，通过maven-assembly-plugin压缩它并添加一个classfier（doc或其他所有东西）。

相关问题

这里有一些信息要完成它：

• Maven best practice for creating ad hoc zip artifact。
• Maven - Depend on assembled zip

即使它已经没问题，但有一点很有趣。

的pom.xml

<groupId>com.mycompany</groupId>
<artifactId>your-project</artifactId>
<version>1.1.0</version>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <executions>
                <execution>
                    <id>doc-packaging</id>
                    <goals>
                        <goal>single</goal>
                    </goals>
                    <phase>package</phase>
                    <configuration>
                        <descriptors>
                            <descriptor>/src/main/assembly/doc.xml</descriptor>
                        </descriptors>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

汇编描述符：它将生成此工件：your-project- doc .zip：

• 这显然是一个zip存档
• ＆＃34;分类器＆＃34;是doc（如汇编名称）

相位绑定

由于pom没有任何准备，你是对的，没有prepare-package阶段（as per doc）。实际上，您的项目旨在打包doc ...因此将（重新）绑定您的pdf插件执行到package是正确的。