license:update-project-license

Full name:

org.kuali.maven.plugins:license-maven-plugin:1.0-kuali-SNAPSHOT:update-project-license

Description:

Updates (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.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
licenseFile File 1.0 Project license file to synchronize with main license defined in descriptor file.
Default value is: ${basedir}/LICENSE.txt.
project MavenProject 1.0 The reacted project.
Default value is: ${project}.

Optional Parameters

Name Type Since Description
bundleLicensePath String 1.0 The path of the bundled license file to produce when generateBundle is on.

Note: This option is not available for pom module types.
Default value is: META-INF/${project.artifactId}-LICENSE.txt.
encoding String 1.0 Encoding used to read and writes files.

Note: If nothing is filled here, we will use the system property file.encoding.
Default value is: ${project.build.sourceEncoding}.
force boolean 1.0.0 A flag to force to generate project license file even if it is up-to-date.
Default value is: false.
generateBundle boolean 1.0 A flag to copy the main license file in a bundled place.

This is usefull for final application to have a none confusing location to seek for the application license.

If Sets to true, will copy the license file to the bundleLicensePath to outputDirectory.

Note: This option is not available for pom module types.
Default value is: false.
keepBackup boolean 1.0 A flag to keep a backup of every modified file.
Default value is: false.
licenseName String 1.0 Name of the license to use in the project.
licenseResolver String 1.0 To specify an external extra licenses repository resolver (says the base url of the repository where the license.properties is present).
outputDirectory File 1.0 The directory where to generate license resources.

Note: This option is not available for pom module types.
Default value is: target/generated-sources/license.
skipUpdateProjectLicense boolean 1.0 A flag to skip the goal.
Default value is: false.
verbose boolean 1.0 Flag to activate verbose mode.

Note: Verbose mode is always on if you starts a debug maven instance (says via -X).
Default value is: ${maven.verbose}.

Parameter Details

bundleLicensePath:

The path of the bundled license file to produce when generateBundle is on.

Note: This option is not available for pom module types.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.bundleLicensePath}
  • Default: META-INF/${project.artifactId}-LICENSE.txt

encoding:

Encoding used to read and writes files.

Note: If nothing is filled here, we will use the system property file.encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.encoding}
  • Default: ${project.build.sourceEncoding}

force:

A flag to force to generate project license file even if it is up-to-date.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • Expression: ${license.force}
  • Default: false

generateBundle:

A flag to copy the main license file in a bundled place.

This is usefull for final application to have a none confusing location to seek for the application license.

If Sets to true, will copy the license file to the bundleLicensePath to outputDirectory.

Note: This option is not available for pom module types.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${license.generateBundle}
  • Default: false

keepBackup:

A flag to keep a backup of every modified file.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${license.keepBackup}
  • Default: false

licenseFile:

Project license file to synchronize with main license defined in descriptor file.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • Expression: ${license.licenceFile}
  • Default: ${basedir}/LICENSE.txt

licenseName:

Name of the license to use in the project.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.licenseName}

licenseResolver:

To specify an external extra licenses repository resolver (says the base url of the repository where the license.properties is present).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.licenseResolver}

outputDirectory:

The directory where to generate license resources.

Note: This option is not available for pom module types.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${license.outputDirectory}
  • Default: target/generated-sources/license

project:

The reacted project.
  • Type: org.apache.maven.project.MavenProject
  • Since: 1.0
  • Required: Yes
  • Default: ${project}

skipUpdateProjectLicense:

A flag to skip the goal.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${license.skipUpdateProjectLicense}
  • Default: false

verbose:

Flag to activate verbose mode.

Note: Verbose mode is always on if you starts a debug maven instance (says via -X).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${license.verbose}
  • Default: ${maven.verbose}