Overview

The commons-build:readme-md goal generates a README.md file for a component. Execute the goal using the following command:

mvn commons-build:readme-md

Note: The README.md should be regenerated after every release of the component since it contains the maven coordinates of the latest release.

This goal uses the following:

• The goal is mapped to the ant script/target using the readme-md mojo definition in the generate-xdocs.mojos.xml mapping document
• Executes the readme-md target in generate-xdocs.build.xml ant script
• Uses the readme-md-template.md template
• Uses the goal's (i.e. mojo's) parameters to filter values in the template

Configuration

To generate a README.md, the following properties are configured in the component's pom.xml

• commons.componentid - Commons component ID
• commons.jira.id - Commons JIRA ID
• commons.release.version - The version number of the latest release of the component

Example configuration for Commons Text:

    <properties>
        <commons.componentid>text</commons.componentid>
        <commons.release.version>1.10.0</commons.release.version>
    </properties>