Apache Commons logo

commons:readme-md

Overview

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

mvn commons: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:

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

    <properties>
        <commons.componentid>chain</commons.componentid>
        <commons.release.version>1.4</commons.release.version>
    </properties>