Plugin Documentation

Goals available for this plugin:

Goal Description
source:aggregate Aggregate sources for all modules in an aggregator project.
source:generated-test-jar This plugin bundles all the test sources into a jar archive.
source:help Display help information on maven-source-plugin.
Call mvn source:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
source:jar This plugin bundles all the sources into a jar archive.
source:jar-no-fork This goal bundles all the sources into a jar archive. This goal functions the same as the jar goal but does not fork the build and is suitable for attaching to the build lifecycle.
source:test-jar This plugin bundles all the test sources into a jar archive.
source:test-jar-no-fork This goal bundles all the test sources into a jar archive. This goal functions the same as the test-jar goal but does not fork the build, and is suitable for attaching to the build lifecycle.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.0
JDK 1.6
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

  1. <project>
  2. ...
  3. <build>
  4. <!-- To define the plugin version in your parent POM -->
  5. <pluginManagement>
  6. <plugins>
  7. <plugin>
  8. <groupId>org.apache.maven.plugins</groupId>
  9. <artifactId>maven-source-plugin</artifactId>
  10. <version>3.0.1</version>
  11. </plugin>
  12. ...
  13. </plugins>
  14. </pluginManagement>
  15. <!-- To use the plugin goals in your POM or parent POM -->
  16. <plugins>
  17. <plugin>
  18. <groupId>org.apache.maven.plugins</groupId>
  19. <artifactId>maven-source-plugin</artifactId>
  20. <version>3.0.1</version>
  21. </plugin>
  22. ...
  23. </plugins>
  24. </build>
  25. ...
  26. </project>

For more information, see "Guide to Configuring Plug-ins"