Plugin Documentation

Goals available for this plugin:

GoalDescription
license:add-third-partyGoal to generate the third-party license file.

This file contains a list of the dependencies and their licenses. Each dependency and it's license is displayed on a single line in the format

  (<license-name>) <project-name> <groupId>:<artifactId>:<version> - <project-url>
It will also copy it in the class-path (says add the generated directory as a resource of the build).
license:aggregate-add-third-partyThis aggregator goal (will be executed only once and only on pom projects) executed the add-third-party on all his modules (in a parellel build cycle) then aggreates all the third-party files in final one in the pom project.
license:comment-style-listDisplays all the available comment style to box file headers.
license:download-licensesDownload the license files of all the current project's dependencies, and generate a summary file containing a list of all dependencies and their licenses.
license:helpDisplay help information on license-maven-plugin.
Call
  mvn license:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
license:license-listDisplay all available licenses.
license:update-file-headerThe goal to update (or add) the header on project source files.

This goal replace the update-header goal which can not deal with Copyright.

This goal use a specific project file descriptor project.xml to describe all files to update for a whole project.

license:update-project-licenseUpdates (or creates) the main project license file according to the given license defines as licenseName.

Can also generate a bundled license file (to avoid collision names in class-path). This file is by default generated in META-INF class-path directory.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven2.2.1
JDK1.6
MemoryNo minimum requirement.
Disk SpaceNo minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.kuali.maven.plugins</groupId>
          <artifactId>license-maven-plugin</artifactId>
          <version>1.6.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.kuali.maven.plugins</groupId>
        <artifactId>license-maven-plugin</artifactId>
        <version>1.6.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"