Apache

Docs Plugins

Help Plugin 3.5.2 · Other versions

The Maven Help plugin provides goals aimed at helping to make sense out of the build environment. It includes the ability to view the effective POM and settings files, after inheritance and active profiles have been applied, as well as a describe a particular plugin goal to give usage information.

Source
Generated from the code
Wrong?
Report a problem

help:effective-pom

Full name:

org.apache.maven.plugins:maven-help-plugin:3.5.2:effective-pom

Description:

Displays the effective POM as an XML for this build, with the active profiles factored in, or a specified artifact. If verbose, a comment is added to each XML element describing the origin of the line.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
<artifact> String 3.0.0 The artifact for which to display the effective POM.
Note: Should respect the Maven format, i.e. groupId:artifactId[:version]. The latest version of the artifact will be used when no version is specified.
User Property: artifact
<output> File - Optional parameter to write the output of this help to a given file using UTF-8 encoding, instead of writing to the console.
Note: Could be a relative path.
User Property: output
<verbose> boolean 3.2.0 Output POM input location as comments.
Default: false
User Property: verbose

Parameter Details

<artifact>

The artifact for which to display the effective POM.
Note: Should respect the Maven format, i.e. groupId:artifactId[:version]. The latest version of the artifact will be used when no version is specified.
  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • User Property: artifact

<output>

Optional parameter to write the output of this help to a given file using UTF-8 encoding, instead of writing to the console.
Note: Could be a relative path.
  • Type: java.io.File
  • Required: No
  • User Property: output

<verbose>

Output POM input location as comments.
  • Type: boolean
  • Since: 3.2.0
  • Required: No
  • User Property: verbose
  • Default: false