Apache Commons logo

commons:readme-md

Overview

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

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

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

    <project>
        <inceptionYear>2018</inceptionYear>
    </project>