Why make donate
Introduction

Maven license Plugin

The Maven License Plugin is used to deal with license stuff on a maven project.

NOTE

The process tags are separated by space otherwise plugin can NOT update header of this file!

What's new in version 3.0

As planned, license descriptor was removed from project.

The consolidation file (called missing file) of the third-party has been improved :

- take account of special dependencies (with zip type for example) - regenerate this file if needed (without using the force flag) - delete from this file all obsolete dependencies no more used in project

Projet will migrate to Codehaus under the name of license-maven-plugin.

This is then the last version under this name. hope you will continue to use it on codehaus forge :).

New location of the project is here : http://mojo.codehaus.org/license-maven-plugin.

What's new in version 2.4 et 2.4.1

We would like not to use any longer project description file since it is too redundant. For that purpose we wrote a new scanning mode for the update-file-header mojo which is automaticly fired when no project file descriptor is found.

The idea of this new mode is quite easy : Sepcify somme roots directories to scan. For each of theses roots, if a file with a known extension is detected then do the magic update of header.

Some default values are offered : roots are : src, target/generated-sources and target/processed-sources.

It is also possible to specify includes and exlcudes files to treate on theses roots by using includes and excludes parameters.

List of all extensions can be found by invoking the comment-style-list goal.

This new mode will replace the descriptor way in version 3 (says file descriptor will disappear for good).

For more information, see the new page Configure update-file-header goal.

What's new in version 2.3.1

Use maven-helper-plugin 1.2.6 (improve default encoding when nothing is specified).

License header

The license header is a comment added on the top of sources files.

To detect the header on files we use processor technology, with tags

  # % L Content # L %

The header is composed of two parts :

  • the first part gives some common information for all files of a maven module (such as project name, organisation, ...). * the second part resumes the license used.

    Here an example :

      /*
       * # % L
       * Plugin maven de changement de license
       * %%
       * Copyright (C) 2008 - 2009 CodeLutin
       * %%
       * This program is free software: you can redistribute it and/or modify
       * it under the terms of the GNU Lesser General Public License as
       * published by the Free Software Foundation, either version 3 of the
       * License, or (at your option) any later version.
       *
       * This program is distributed in the hope that it will be useful,
       * but WITHOUT ANY WARRANTY; without even the implied warranty of
       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       * GNU General Lesser Public License for more details.
       *
       * You should have received a copy of the GNU General Lesser Public
       * License along with this program.  If not, see
       * <http://www.gnu.org/licenses/lgpl-3.0.html>.
       * # L %
       */

Goals Overview

The plugin has the following goals:

Usage

Instructions on how to use the Plugin can be found on usage page

Examples

To come soon.

Maven JRst ReStructuredText