Apache Commons logo

commons:readme-md

Full name:

org.apache.commons:commons-build-plugin:1.6:readme-md

Description:

Apache Commons Build Mojo: Generate README.md

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Is NOT inherited by default in multi-project builds.

Required Parameters

Name Type Since Description
commons.release.version String - The version of the latest release of the project.
Default value is: ${commons.release.version}.
commons.componentid String - Commons component id.
Default value is: ${commons.componentid}.
basedir File - The base directory from which to execute the Ant script.
Default value is: ${basedir}.

Optional Parameters

Name Type Since Description
messageLevel String - The message-level used to tune the verbosity of Ant logging.
Default value is: info.

Parameter Details

commons.release.version:

The version of the latest release of the project.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.release.version}

commons.componentid:

The Commons componentid.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${commons.componentid}

basedir:

The base directory from which to execute the Ant script.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${antBasedir}
  • Default: ${basedir}

messageLevel:

The message-level used to tune the verbosity of Ant logging.
  • Type: java.lang.String
  • Required: No
  • Expression: ${antMessageLevel}
  • Default: info