helper:collect-files

Full name:

org.nuiton:helper-maven-plugin:2.3.2:collect-files

Description:

Collect files some files from a project and copy them into a directory.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.1.0.

Required Parameters

Name Type Since Description
encoding String 1.0.0 Encoding a utiliser pour lire et ecrire les fichiers.
Default value is: ${project.build.sourceEncoding}.
User property is: helper.encoding.

Optional Parameters

Name Type Since Description
copyFiles boolean 1.0.0 Un flag pour recopier les fichiers collectés.
Default value is: true.
User property is: helper.copyFiles.
descriptionFile String 1.0.0 File with all files collected (one file by line in absolute path). Note : If not Set, will not generate the description file.
User property is: helper.descriptionFile.
dryRun boolean 1.0.0 Un flag pour activer le mode verbeux.
Default value is: false.
User property is: helper.dryRun.
excludes String 1.0.0 File name pattern of selected files to publish. If no Set - no exclude filter
User property is: helper.excludes.
extraFiles String 1.0.0 User extra files to collect. Multi values can be used, separated by comma.
User property is: helper.extraFiles.
includeAttached boolean 1.0.0 Un flag pour collecter aussi les fichiers attaches au projet.
Default value is: true.
User property is: helper.includeAttached.
includeSiteAttached boolean 1.2.2 Un flag pour collecter aussi les fichiers des sites attaches au projet.
Default value is: false.
User property is: helper.includeSiteAttached.
includes String 1.0.0 File name pattern of selected files to publish. If no Set - no include filter
User property is: helper.includes.
outputDirectory String 1.0.0 Directory where to store collected files. Note : In a multi-module context, will always use the value of the property of the root module, because we need to push collected files to only one place.
Default value is: target/collect.
User property is: helper.outputDirectory.
skip boolean 1.0.0 A flag to skip the goal.
Default value is: false.
User property is: helper.skip.
verbose boolean 1.0.0 Un flag pour activer le mode verbeux.
Default value is: ${maven.verbose}.
User property is: helper.verbose.

Parameter Details

copyFiles:

Un flag pour recopier les fichiers collectés.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: helper.copyFiles
  • Default: true

descriptionFile:

File with all files collected (one file by line in absolute path). Note : If not Set, will not generate the description file.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: helper.descriptionFile

dryRun:

Un flag pour activer le mode verbeux.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: helper.dryRun
  • Default: false

encoding:

Encoding a utiliser pour lire et ecrire les fichiers.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: helper.encoding
  • Default: ${project.build.sourceEncoding}

excludes:

File name pattern of selected files to publish. If no Set - no exclude filter
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: helper.excludes

extraFiles:

User extra files to collect. Multi values can be used, separated by comma.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: helper.extraFiles

includeAttached:

Un flag pour collecter aussi les fichiers attaches au projet.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: helper.includeAttached
  • Default: true

includeSiteAttached:

Un flag pour collecter aussi les fichiers des sites attaches au projet.
  • Type: boolean
  • Since: 1.2.2
  • Required: No
  • User Property: helper.includeSiteAttached
  • Default: false

includes:

File name pattern of selected files to publish. If no Set - no include filter
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: helper.includes

outputDirectory:

Directory where to store collected files. Note : In a multi-module context, will always use the value of the property of the root module, because we need to push collected files to only one place.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: helper.outputDirectory
  • Default: target/collect

skip:

A flag to skip the goal.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: helper.skip
  • Default: false

verbose:

Un flag pour activer le mode verbeux.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: helper.verbose
  • Default: ${maven.verbose}