commons-build:readme-md
Full name:
org.apache.commons:commons-build-plugin:1.14.0:readme-md
Description:
Apache Commons Build Mojo: Generate README.md.
Attributes:
- Requires a Maven project to be executed.
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Is NOT inherited by default in multi-project builds.
Required Parameters
| Name |
Type |
Since |
Description |
<basedir> |
File |
- |
The base directory from which to execute the Ant script.
Default: ${basedir}
User Property: antBasedir
Alias: ant.basedir |
<commons.jira.id> |
String |
- |
The external JIRA id for the project (alphabetic, upper case.)
Default: ${commons.jira.id} |
<commons.release.version> |
String |
- |
The version of the latest release of the project.
Default: ${commons.release.version} |
Optional Parameters
| Name |
Type |
Since |
Description |
<messageLevel> |
String |
- |
The message-level used to tune the verbosity of Ant logging.
Default: info
User Property: antMessageLevel
Alias: ant.messageLevel |
Parameter Details
The base directory from which to execute the Ant script.
- Type:
java.io.File
- Required:
report.plugin.goal.yes
- User Property:
antBasedir
- Default:
${basedir}
- Alias:
ant.basedir
The external JIRA id for the project (alphabetic, upper case.)
- Type:
java.lang.String
- Required:
report.plugin.goal.yes
- Default:
${commons.jira.id}
<commons.release.version>
The version of the latest release of the project.
- Type:
java.lang.String
- Required:
report.plugin.goal.yes
- Default:
${commons.release.version}
The message-level used to tune the verbosity of Ant logging.
- Type:
java.lang.String
- Required:
report.plugin.goal.no
- User Property:
antMessageLevel
- Default:
info
- Alias:
ant.messageLevel
|
