Fork me on GitHub

license:check-project-license

Full name:

org.codehaus.mojo:license-maven-plugin:2.7.0:check-project-license

Description:

The goal to check if there are license files in project.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.7.0.

Optional Parameters

Name Type Since Description
<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: ${project.build.sourceEncoding}
User Property: license.encoding
<failOnMissingLicense> boolean 2.7.0 A flag to fail the build if there is missing any license file.
Default: false
User Property: license.failOnMissingLicense
<licenseFile> File 2.7.0 Project license file to check.
Default: LICENSE.txt
User Property: license.licenceFile
<skipCheckLicense> boolean 2.7.0 A flag to skip the goal.
Default: false
User Property: license.skipCheckLicense
<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: ${maven.verbose}
User Property: license.verbose

Parameter Details

<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
  • User Property: license.encoding
  • Default: ${project.build.sourceEncoding}

<failOnMissingLicense>

A flag to fail the build if there is missing any license file.
  • Type: boolean
  • Since: 2.7.0
  • Required: No
  • User Property: license.failOnMissingLicense
  • Default: false

<licenseFile>

Project license file to check.
  • Type: java.io.File
  • Since: 2.7.0
  • Required: No
  • User Property: license.licenceFile
  • Default: LICENSE.txt

<skipCheckLicense>

A flag to skip the goal.
  • Type: boolean
  • Since: 2.7.0
  • Required: No
  • User Property: license.skipCheckLicense
  • 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
  • User Property: license.verbose
  • Default: ${maven.verbose}