Copyright check/repair maven plugin
I've created a maven plugin to check for the proper copyright/license headers
and (in some cases) repair incorrect files.
Configure it as follows:
org.glassfish.build
glassfish-copyright-maven-plugin
copyright-exclude
org.glassfish.build
glassfish-copyright-maven-plugin
insert latest GlassFish version
To check copyrights and report errors:
$ mvn glassfish-copyright:copyright
To only check copyrights, failing the build if there are any errors:
$ mvn glassfish-copyright:check
To repair any errors discovered (use this carefully, and check the results):
$ mvn glassfish-copyright:repair
You can add the following items in the section:
file of exclude patterns
an exclude pattern
svn|mercurial|git - defaults to svn
true - turn on debugging
false - for use with repair
false - turn off warnings
true - don't check that year is correct
true - skip files not under SCM
file containg template
There are various errors that this plugin will correct:
- no copyright at all; these are the most likely cases for the plugin to
do the wrong thing.
- a known, but incorrect, copyright.
- the correct copyright, but the copyright year wasn't updated.
Note that the repair option doesn't know what the copyright for a
file *should* be. If the only thing wrong is the date, it just fixes
it. But if the header is wrong it assumes the file should have the
CDDL+GPL copyright, and replaces any existing copyright with that.
If the file has a BSD license, it relaces it with the standard BSD
license. If the file has "supplemental" license text in our standard
format (e.g., an Apache or MIT license), it tries to preserve that.
However, if the file is *intended* to have one of the Apache-derived
copyright/license headers or the BSD license (for example), but
doesn't, or it isn't in the expected format, the wrong license will
be applied.
If you have files that should be excluded from the checks (e.g.,
because they purposely have a different license), you can use the
option to list them. You can repeat the as many times
as you need it, or you can put the names in the file and specify the
file name to the option.
The excluded names are *substrings* (not regular expressions) that
are matched against the path/file name.
Good entries for an exclude list are:
/MANIFEST.MF
/META-INF/services/
/README
.gif
.jpg
.png
.exe
.ico
.jar
.zip
.war
.sql
.jks
.json
.class