如何将README.md复制到src / main / resources中?

时间:2015-02-17 12:32:23

标签: java maven maven-plugin maven-resources-plugin

我想在我的网络应用程序中显示README.md文件,例如帮助页面。为了不创建重复,我需要将mvn从项目路径复制到资源中。

我该怎么办?

有什么想法吗?

我试过了:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <version>2.3</version>

    <configuration>
        <!-- this is important -->
        <overwrite>true</overwrite>
        <!-- target -->
        <outputDirectory>${basedir}/target/classes</outputDirectory>
        <resources>
            <resource>
                <!-- source -->
                <directory>/</directory>
                <include>
                    <filter>**/README.md</filter>
                </include>
            </resource>
        </resources>
    </configuration>
</plugin>

3 个答案:

答案 0 :(得分:2)

最简单的解决方案是将相应的文件移动到src/main/resources文件夹,而第二个解决方案可能是这样的:

  <build>
    <resources>
      <resource>
        <directory>${project.basedir}</directory>
        <includes>
          <include>README.md</include>
        </includes>
        <filtering>true</filtering>
      </resource>
    </resources>
  </build>

无需配置maven-resources-plugin,这可以通过常规的生命周期和资源处理来处理。您可能需要调整的唯一内容是README.md所在的文件夹。如果您想要过滤,则还需要添加<filtering>true</filtering>部分。

在构建src/**期间通过Maven复制内容通常是一个坏主意,因为这些文件夹由版本控制系统控制,这将导致您不喜欢的未提交的更改。< / p>

注意:检查插件的最新版本是明智的(原因2.3是2008年!)。可以在此处找到当前插件版本的列表:http://maven.apache.org/plugins/

答案 1 :(得分:1)

这在我的一个项目中对我有用:

<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <version>2.4.3</version>
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>validate</phase>
            <!-- when to execute copy operation -->
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <resources>
                    <resource>
                        <directory>${basedir}/pathTo.MD</directory>
                    </resource>
                </resources>
                <overwrite>true</overwrite>
                <outputDirectory>${project.build.directory}/${project.build.finalName}/classes</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

我看到我的版本中有相位和目标。我还使用变量作为输出位置。

答案 2 :(得分:0)

我建议你更接近这个例子:http://maven.apache.org/plugins/maven-resources-plugin/examples/copy-resources.html 与#34;更平等&#34;我的意思是使用<executions>标记。

您当然可以省略<id>filtering等内容。

以下对我来说很好:

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.7</version>
        <executions>
          <execution>
            <id>myID</id>
            <!-- here the phase you need -->
            <phase>validate</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <outputDirectory>${basedir}/target/extra-resources</outputDirectory>
              <overwrite>true</overwrite>
              <resources>          
                <resource>
                  <directory>src</directory>
                  <!-- Details about filtering: http://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html -->
                  <filtering>true</filtering>
                </resource>
              </resources>              
            </configuration>            
          </execution>
        </executions>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>