Overview

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

mvn commons-build:notice-txt

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 notice-txt mojo definition in the generate-xdocs.mojos.xml mapping document
• Executes the notice-txt target in generate-xdocs.build.xml ant script
• Uses the notice-txt-template.txt 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

• project.inceptionYear - The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.

Example configuration for Commons Text:

    <project>
        <inceptionYear>2014</inceptionYear>
    </project>