plugin:descriptor

Full name:

org.apache.maven.plugins:maven-plugin-plugin:3.0:descriptor

Description:

Generate a plugin descriptor.
Note: Since 3.0, phase is after the "compilation" of any scripts.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
encoding String 2.5 The file encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
extractors Set 2.0 The role names of mojo extractors to use. If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors will be used. Example: 
 <!-- Use all mojo extractors -->
 <extractors/>

 <!-- Use no mojo extractors -->
 <extractors>
     <extractor/>
 </extractors>

 <!-- Use only bsh mojo extractor -->
 <extractors>
     <extractor>bsh</extractor>
 </extractors>

goalPrefix String 2.0 The goal prefix that will appear before the ":".
outputDirectory File 2.0 The directory where the generated plugin.xml file will be put.
Default value is: ${project.build.outputDirectory}/META-INF/maven.
skip boolean 2.8 Set this to "true" to skip invoking any goals or reports of the plugin.
Default value is: false.
skipDescriptor boolean 2.6 A flag to disable generation of the plugin.xml in favor of a hand authored plugin descriptor.
Default value is: false.
skipErrorNoDescriptorsFound boolean 3.0 By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the descriptor generator mojo is bound to generate-resources phase. But for annotations, the compiled classes are needed, so skip error
Default value is: false.

Parameter Details

encoding:

The file encoding of the source files.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

extractors:

The role names of mojo extractors to use. If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors will be used. Example: 
 <!-- Use all mojo extractors -->
 <extractors/>

 <!-- Use no mojo extractors -->
 <extractors>
     <extractor/>
 </extractors>

 <!-- Use only bsh mojo extractor -->
 <extractors>
     <extractor>bsh</extractor>
 </extractors>
  • Type: java.util.Set
  • Since: 2.0
  • Required: No

goalPrefix:

The goal prefix that will appear before the ":".
  • Type: java.lang.String
  • Since: 2.0
  • Required: No

outputDirectory:

The directory where the generated plugin.xml file will be put.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.outputDirectory}/META-INF/maven

skip:

Set this to "true" to skip invoking any goals or reports of the plugin.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Expression: ${maven.plugin.skip}
  • Default: false

skipDescriptor:

A flag to disable generation of the plugin.xml in favor of a hand authored plugin descriptor.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Default: false

skipErrorNoDescriptorsFound:

By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the descriptor generator mojo is bound to generate-resources phase. But for annotations, the compiled classes are needed, so skip error
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${maven.plugin.skipErrorNoDescriptorsFound}
  • Default: false