source:aggregate

Full name:

org.apache.maven.plugins:maven-source-plugin:2.1.2:aggregate

Description:

Aggregate sources for all modules in an aggregator project.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Executes as an aggregator plugin.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0.3.
  • Binds by default to the lifecycle phase: package.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration 2.1 The archive configuration to use. See Maven Archiver Reference.
attach boolean 2.0.3 Specifies whether or not to attach the artifact to the project
Default value is: true.
excludeResources boolean 2.0.4 Specifies whether or not to exclude resources from the sources-jar. This can be convenient if your project includes large resources, such as images, and you don't want to include them in the sources-jar.
Default value is: false.
excludes String[] 2.1 List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
finalName String 2.0.3 The filename to be used for the generated archive file. For the source:jar goal, "-sources" is appended to this filename. For the source:test-jar goal, "-test-sources" is appended.
Default value is: ${project.build.finalName}.
forceCreation boolean 2.1 Whether creating the archive should be forced. If set to true, the jar will always be created. If set to false, the jar will only be created when the sources are newer than the jar.
Default value is: false.
includePom boolean 2.1 Specifies whether or not to include the POM file in the sources-jar.
Default value is: false.
includes String[] 2.1 List of files to include. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
outputDirectory File 2.0.3 The directory where the generated archive file will be put.
Default value is: ${project.build.directory}.
useDefaultExcludes boolean 2.1 Exclude commonly excluded files such as SCM configuration. These are defined in the plexus FileUtils.getDefaultExcludes()
Default value is: true.
useDefaultManifestFile boolean 2.1 Set this to true to enable the use of the defaultManifestFile.

Default value is: false.

Parameter Details

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Since: 2.1
  • Required: No

attach:

Specifies whether or not to attach the artifact to the project
  • Type: boolean
  • Since: 2.0.3
  • Required: No
  • Expression: ${attach}
  • Default: true

excludeResources:

Specifies whether or not to exclude resources from the sources-jar. This can be convenient if your project includes large resources, such as images, and you don't want to include them in the sources-jar.
  • Type: boolean
  • Since: 2.0.4
  • Required: No
  • Expression: ${source.excludeResources}
  • Default: false

excludes:

List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
  • Type: java.lang.String[]
  • Since: 2.1
  • Required: No

finalName:

The filename to be used for the generated archive file. For the source:jar goal, "-sources" is appended to this filename. For the source:test-jar goal, "-test-sources" is appended.
  • Type: java.lang.String
  • Since: 2.0.3
  • Required: No
  • Default: ${project.build.finalName}

forceCreation:

Whether creating the archive should be forced. If set to true, the jar will always be created. If set to false, the jar will only be created when the sources are newer than the jar.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${source.forceCreation}
  • Default: false

includePom:

Specifies whether or not to include the POM file in the sources-jar.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${source.includePom}
  • Default: false

includes:

List of files to include. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
  • Type: java.lang.String[]
  • Since: 2.1
  • Required: No

outputDirectory:

The directory where the generated archive file will be put.
  • Type: java.io.File
  • Since: 2.0.3
  • Required: No
  • Default: ${project.build.directory}

useDefaultExcludes:

Exclude commonly excluded files such as SCM configuration. These are defined in the plexus FileUtils.getDefaultExcludes()
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Default: true

useDefaultManifestFile:

Set this to true to enable the use of the defaultManifestFile.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Default: false