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:evaluate

Full name:

org.apache.maven.plugins:maven-help-plugin:3.5.2:evaluate

Description:

Evaluates Maven expressions given by the user in an interactive mode.

Attributes:

  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.1.

Optional Parameters

Name Type Since Description
<artifact> String - An artifact for evaluating Maven expressions.
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
<expression> String - An expression to evaluate instead of prompting. Note that this may not include the surrounding ${...}.
User Property: expression
<forceStdout> boolean 3.1.0 This options gives the option to output information in cases where the output has been suppressed by using -q (quiet option) in Maven. This is useful if you like to use maven-help-plugin:evaluate in a script call (for example in bash) like this: 
RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
echo $RESULT
This will only printout the information which has been requested by expression to stdout.
Default: false
User Property: forceStdout
<output> File 3.0.0 Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no expression is specified.
Note: Could be a relative path.
User Property: output

Parameter Details

<artifact>

An artifact for evaluating Maven expressions.
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
  • Required: No
  • User Property: artifact

<expression>

An expression to evaluate instead of prompting. Note that this may not include the surrounding ${...}.
  • Type: java.lang.String
  • Required: No
  • User Property: expression

<forceStdout>

This options gives the option to output information in cases where the output has been suppressed by using -q (quiet option) in Maven. This is useful if you like to use maven-help-plugin:evaluate in a script call (for example in bash) like this: 
RESULT=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
echo $RESULT
This will only printout the information which has been requested by expression to stdout.
  • Type: boolean
  • Since: 3.1.0
  • Required: No
  • User Property: forceStdout
  • Default: false

<output>

Optional parameter to write the output of this help in a given file, instead of writing to the console. This parameter will be ignored if no expression is specified.
Note: Could be a relative path.
  • Type: java.io.File
  • Since: 3.0.0
  • Required: No
  • User Property: output