Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

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 4.0.0-beta-3
JDK 17

System Requirements History

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

Plugin Version Maven JDK
4.0.0-beta-1 4.0.0-beta-3 17
from 3.3.0 to 3.3.1 3.2.5 8
from 3.1.0 to 3.2.1 3.0 7
from 3.0.0 to 3.0.1 3.0 6
2.4 2.2.1 5
from 2.2 to 2.3 2.0.9 5
from 2.1 to 2.1.2 2.0.6 1.4
2.0.4 2.0 1.4
from 2.0.2 to 2.0.3 2.0 -
from 2.0-beta-1 to 2.0.1 - -

Usage

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

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-source-plugin</artifactId>
          <version>4.0.0-beta-1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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