mtitek
  • Cloud
  • Big Data
  • CI
  • Install
  • Samples
  • Java
  • Ubuntu
  • Maven
  • Archive
Maven | maven-help-plugin
  1. Help
  2. The goal describe

  1. Help
    Name: Apache Maven Help Plugin

    Description: 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.

    Plugin coordinates:
    Group Id: org.apache.maven.plugins
    Artifact Id: maven-help-plugin
    Version: 3.2.0

    Goal Prefix: help

    The goal help:help gives general information about the help plugin and lists its goals:

    The goal help:describe gives detailed information about any Maven plugin and lists its goals:

    The help plugin has the following goals:
    • help: Displays help information on maven-help-plugin.

    • describe: Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object).

    • system: Displays a list of the platform details like system properties and environment variables.

    • effective-pom: Displays the effective POM as an XML for this build.

    • effective-settings: Displays the calculated settings as XML for this project.

    • active-profiles: Displays a list of the profiles which are currently active for this build.

    • all-profiles: Displays a list of available profiles under the current project.

    • evaluate: Evaluates Maven expressions given by the user in an interactive mode.
  2. The goal describe
    The goal describe gives information about a maven plugin and lists its goals.
    This goal can be used with any maven plugin including the help plugin itself.

    Usage: You must specify either a 'cmd' parameter, or a 'plugin' parameter, or both 'groupId' and 'artifactId' parameters.

    Here are some examples of how to use this goal:
    • mvn help:describe -Dcmd=<phase-name>
    • mvn help:describe -Dcmd=<plugin-prefix:goal-name>
    • mvn help:describe -Dplugin=<plugin-prefix>
    • mvn help:describe -Dplugin=<plugin-group-id:plugin-artifact-id>
    • mvn help:describe -DgroupId=<plugin-group-id> -DartifactId=<plugin-artifact-id>
    • mvn help:describe -DgroupId=<plugin-group-id> -DartifactId=<plugin-artifact-id> -Dversion=<plugin-version>
    To display the list of parameters for each goal, use the parameter detail:

    To display the list of parameters for a specific goal, use the parameter goal:
© 2020  mtitek