Fork me on GitHub
Built by Maven

license:process

Full name:

io.jenkins.tools.maven:license-maven-plugin:999999-SNAPSHOT:process

Description:

Process license information.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Optional Parameters

Name Type Since Description
<attach> boolean - If true, attach the generated XML/HTML as artifacts (to be installed/deployed to Maven repositories.)
Default: ${license.attach}
<disableCheck> boolean - Forbidden switch to disable and bypass all the checks.
Default: ${license.disableCheck}
<generateLicenseHtml> File - If true, generate "licenses.html" as the visualization of license.xml
Default: ${license.generateLicenseHtml}
<generateLicenseXml> File - If true, generate "licenses.xml" that captures all the dependencies and its licenses.
Default: ${license.generateLicenseXml}
<inlineScript> String - Specifies completion/generation/filtering script inline.
<requireCompleteLicenseInfo> boolean - If true, require all the dependencies to have license information after running completion scripts, or fail the build.
<script> File - Specifies completion/generation/filtering scripts.

This can be either a file or a directory. If it's a directory all the files in it are assumed to be completer scripts.


Default: ${license.script}

Parameter Details

<attach>

If true, attach the generated XML/HTML as artifacts (to be installed/deployed to Maven repositories.)
  • Type: boolean
  • Required: No
  • Default: ${license.attach}

<disableCheck>

Forbidden switch to disable and bypass all the checks.
  • Type: boolean
  • Required: No
  • Default: ${license.disableCheck}

<generateLicenseHtml>

If true, generate "licenses.html" as the visualization of license.xml
  • Type: java.io.File
  • Required: No
  • Default: ${license.generateLicenseHtml}

<generateLicenseXml>

If true, generate "licenses.xml" that captures all the dependencies and its licenses.
  • Type: java.io.File
  • Required: No
  • Default: ${license.generateLicenseXml}

<inlineScript>

Specifies completion/generation/filtering script inline.
  • Type: java.lang.String
  • Required: No

<requireCompleteLicenseInfo>

If true, require all the dependencies to have license information after running completion scripts, or fail the build.
  • Type: boolean
  • Required: No

<script>

Specifies completion/generation/filtering scripts.

This can be either a file or a directory. If it's a directory all the files in it are assumed to be completer scripts.

  • Type: java.io.File
  • Required: No
  • Default: ${license.script}