Maven License Plugin - license:aggregate-add-third-party

license:aggregate-add-third-party

Nom complet :

org.nuiton:maven-license-plugin:3.0:aggregate-add-third-party

Description :

This aggregator goal (will be executed only once and only on pom projects) executed the add-third-party on all his modules (in a parellel build cycle) then aggreates all the third-party files in final one in the pom project.

Attributs :

Exige un projet Maven 2.0 pour être exécuté.
S'exécute comme un plugin agrégé.
Depuis la version : 2.3.
S'associe par défaut dans la phase du cycle de vie : generate-resources.
Appelle l'exécution du goal de ce plugin add-third-party avant de s'exécuter.

Paramètres requis

Nom	Type	Depuis	Description
outputDirectory	`File`	`2.3`	Directory where to generate files. Valeur par défaut est : `target/generated-sources/license`.
project	`MavenProject`	`2.1`	The reacted project. Valeur par défaut est : `${project}`.
thirdPartyFilename	`String`	`2.3`	File where to wirte the third-party file. Valeur par défaut est : `THIRD-PARTY.txt`.

Paramètres optionnels

Nom	Type	Depuis	Description
bundleThirdPartyPath	`String`	`2.3`	The path of the bundled third party file to produce when `generateBundle` is on. Note: This option is not available for `pom` module types. Valeur par défaut est : `META-INF/${project.artifactId}-THIRD-PARTY.txt`.
encoding	`String`	`2.1`	Encoding used to read and writes files. Note: If nothing is filled here, we will use the system property `file.encoding`. Valeur par défaut est : `${project.build.sourceEncoding}`.
excludedArtifacts	`String`	`2.3.2`	A filter to exclude some ArtifactsIds
excludedGroups	`String`	`2.3.2`	A filter to exclude some GroupIds
failIfWarning	`boolean`	`2.3`	A flag to fail the build if at least one dependency was detected without a license. Valeur par défaut est : `false`.
force	`boolean`	`2.3`	To force generation of the third-party file even if every thing is up to date. Valeur par défaut est : `false`.
generateBundle	`boolean`	`2.3`	A flag to copy a bundled version of the third-party file. This is usefull to avoid for a final application collision name of third party file. The file will be copied at the `bundleThirdPartyPath` location. Valeur par défaut est : `false`.
groupByLicense	`boolean`	`2.3`	A flag to change the grouping of the generated THIRD-PARTY file. By default, group by dependecies. If sets to `true`, the it will group by license type. Valeur par défaut est : `false`.
includedArtifacts	`String`	`2.3.2`	A filter to include only some ArtifactsIds
includedGroups	`String`	`2.3.2`	A filter to include only some GroupIds
licenseMerges	`List`	`2.3`	To merge licenses in final file. Each entry represents a merge (first license is main license to keep), licenses are separated by `\|`. Example : <licenseMerges> <licenseMerge>The Apache Software License\|Version 2.0,Apache License, Version 2.0</licenseMerge> </licenseMerges> </pre>
missingFile	`File`	`2.3`	The file where to fill the license for dependencies with unknwon license. Valeur par défaut est : `src/license/THIRD-PARTY.properties`.
useMissingFile	`boolean`	`2.3`	A flag to use the missing licenses file to consolidate the THID-PARTY file. Valeur par défaut est : `false`.
verbose	`boolean`	`2.1`	Flag to activate verbose mode. Note: Verbose mode is always on if you starts a debug maven instance (says via `-X`). Valeur par défaut est : `${maven.verbose}`.

Détails des paramètres

bundleThirdPartyPath :

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

Note: This option is not available for pom module types.

Type : java.lang.String
Depuis : 2.3
Exigé : Non
Expression : ${license.bundleThirdPartyPath}
Défaut : META-INF/${project.artifactId}-THIRD-PARTY.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
Depuis : 2.1
Exigé : Non
Expression : ${license.encoding}
Défaut : ${project.build.sourceEncoding}

excludedArtifacts :

A filter to exclude some ArtifactsIds

Type : java.lang.String
Depuis : 2.3.2
Exigé : Non
Expression : ${license.excludedArtifacts}

excludedGroups :

A filter to exclude some GroupIds

Type : java.lang.String
Depuis : 2.3.2
Exigé : Non
Expression : ${license.excludedGroups}

failIfWarning :

A flag to fail the build if at least one dependency was detected without a license.

Type : boolean
Depuis : 2.3
Exigé : Non
Expression : ${license.failIfWarning}
Défaut : false

force :

To force generation of the third-party file even if every thing is up to date.

Type : boolean
Depuis : 2.3
Exigé : Non
Expression : ${license.force}
Défaut : false

generateBundle :

A flag to copy a bundled version of the third-party file. This is usefull to avoid for a final application collision name of third party file. The file will be copied at the bundleThirdPartyPath location.

Type : boolean
Depuis : 2.3
Exigé : Non
Expression : ${license.generateBundle}
Défaut : false

groupByLicense :

A flag to change the grouping of the generated THIRD-PARTY file.

By default, group by dependecies.

If sets to true, the it will group by license type.

Type : boolean
Depuis : 2.3
Exigé : Non
Expression : ${license.groupByLicense}
Défaut : false

includedArtifacts :

A filter to include only some ArtifactsIds

Type : java.lang.String
Depuis : 2.3.2
Exigé : Non
Expression : ${license.includedArtifacts}

includedGroups :

A filter to include only some GroupIds

Type : java.lang.String
Depuis : 2.3.2
Exigé : Non
Expression : ${license.includedGroups}

licenseMerges :

To merge licenses in final file.

Each entry represents a merge (first license is main license to keep), licenses are separated by |.

Example :

<licenseMerges>
<licenseMerge>The Apache Software License|Version 2.0,Apache License, Version 2.0</licenseMerge>
</licenseMerges>
</pre>

Type : java.util.List
Depuis : 2.3
Exigé : Non

missingFile :

The file where to fill the license for dependencies with unknwon license.

Type : java.io.File
Depuis : 2.3
Exigé : Non
Expression : ${license.missingFile}
Défaut : src/license/THIRD-PARTY.properties

outputDirectory :

Directory where to generate files.

Type : java.io.File
Depuis : 2.3
Exigé : Oui
Expression : ${license.outputDirectory}
Défaut : target/generated-sources/license

project :

The reacted project.

Type : org.apache.maven.project.MavenProject
Depuis : 2.1
Exigé : Oui
Défaut : ${project}

thirdPartyFilename :

File where to wirte the third-party file.

Type : java.lang.String
Depuis : 2.3
Exigé : Oui
Expression : ${license.thirdPartyFilename}
Défaut : THIRD-PARTY.txt

useMissingFile :

A flag to use the missing licenses file to consolidate the THID-PARTY file.

Type : boolean
Depuis : 2.3
Exigé : Non
Expression : ${license.useMissingFile}
Défaut : 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
Depuis : 2.1
Exigé : Non
Expression : ${license.verbose}
Défaut : ${maven.verbose}

Utilisateur

Téléchargements

Documentation sur le projet

license:aggregate-add-third-party

Paramètres requis

Paramètres optionnels

Détails des paramètres