bulk-deploy:deploy-folder

Full name:

org.bsc.maven.plugin:bulk-deploy:2.1:deploy-folder

Description:

Installs artifacts from folder to remote repository.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
<outputFolder> File - Folder to be deployed.
User property is: project.build.directory.
<repositoryLayout> String - The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout.
Default value is: default.
User property is: repositoryLayout.
<sourceFolder> File - Folder to be deployed.
User property is: sourceFolder.
<url> String - URL where the artifact will be deployed.
ie ( file://C:\m2-repo or scp://host.com/path/to/repo )
User property is: url.

Optional Parameters

Name Type Since Description
<_updatePom> boolean - add generated dependency to pom
Default value is: false.
User property is: deploy.updatePom.
<artifactIdPostfix> String - ArtifactId postfix of the artifacts to be deployed. Retrieved from POM file if specified.
User property is: artifactId-postfix.
<artifactIdPrefix> String - ArtifactId prefix of the artifacts to be deployed. Retrieved from POM file if specified.
User property is: artifactId-prefix.
<description> String - Description passed to a generated POM file (in case of generatePom=true)
User property is: generatePom.description.
<excludes> String[] - A list of exclusion filters from sourceFolder
<failOnError> boolean 2.1 Ignore errors on deployments
Default value is: true.
User property is: deploy.failOnError.
<filePattern> String - reg-ex pattern. If it matchs then group(1) will be artifactId and group(2) will be version
User property is: filePattern.
<generatePom> boolean - Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.
Default value is: true.
User property is: generatePom.
<groupId> String - GroupId of the artifact to be deployed. Retrieved from POM file if specified.
It must be always specified in case of fat jar to allow the plugin to localize the correct pom.properties (multiple pom.properties)
User property is: groupId.
<ignorePomProperties> boolean - issue #2 : skip check pom.properties inside jar
Default value is: false.
User property is: ignorePomProperties.
<includes> String[] - A list of inclusion filters from sourceFolder
<preview> boolean - preview mode
Default value is: false.
<repositoryId> String - Server Id to map on the <id> under <server> section of settings.xml In most cases, this parameter will be required for authentication.
Default value is: remote-repository.
User property is: repositoryId.
<uniqueVersion> boolean - Whether to deploy snapshots with a unique version or not.
Default value is: true.
User property is: uniqueVersion.
<useSameGroupIdAsArtifactId> boolean - For not maven standard artifacts a new not mandatory parameter like useSameGroupIdAsArtifactId could be useful to avoid the awkwardness of regex groups matching artifactId and GroupId.
A thumb rule could be:
  • take all filename content after the last - and before file extension and manage it as a fallback to version parameter.
  • all content before the last - or before .jar identify both artifactId and GroupId.
Example: 
guava-19.0.jar

If version not set and useSameGroupIdAsArtifactId = true

   groupId:      guava
   artifactId:   guava
   version:      19.0

   if version set to xxx and useSameGroupIdAsArtifactId = true

   groupId:      guava-19.0
   artifactId:   guava-19.0
   version:      xxx

Default value is: false.
User property is: useSameGroupIdAsArtifactId.
<version> String - Version of the artifact to be deployed. Retrieved from POM file if specified.
User property is: version.

Parameter Details

<_updatePom>

add generated dependency to pom
  • Type: boolean
  • Required: No
  • User Property: deploy.updatePom
  • Default: false

<artifactIdPostfix>

ArtifactId postfix of the artifacts to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • User Property: artifactId-postfix

<artifactIdPrefix>

ArtifactId prefix of the artifacts to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • User Property: artifactId-prefix

<description>

Description passed to a generated POM file (in case of generatePom=true)
  • Type: java.lang.String
  • Required: No
  • User Property: generatePom.description

<excludes>

A list of exclusion filters from sourceFolder
  • Type: java.lang.String[]
  • Required: No

<failOnError>

Ignore errors on deployments
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: deploy.failOnError
  • Default: true

<filePattern>

reg-ex pattern. If it matchs then group(1) will be artifactId and group(2) will be version
  • Type: java.lang.String
  • Required: No
  • User Property: filePattern

<generatePom>

Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.
  • Type: boolean
  • Required: No
  • User Property: generatePom
  • Default: true

<groupId>

GroupId of the artifact to be deployed. Retrieved from POM file if specified.
It must be always specified in case of fat jar to allow the plugin to localize the correct pom.properties (multiple pom.properties)
  • Type: java.lang.String
  • Required: No
  • User Property: groupId

<ignorePomProperties>

issue #2 : skip check pom.properties inside jar
  • Type: boolean
  • Required: No
  • User Property: ignorePomProperties
  • Default: false

<includes>

A list of inclusion filters from sourceFolder
  • Type: java.lang.String[]
  • Required: No

<outputFolder>

Folder to be deployed.
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory

<preview>

preview mode
  • Type: boolean
  • Required: No
  • Default: false

<repositoryId>

Server Id to map on the <id> under <server> section of settings.xml In most cases, this parameter will be required for authentication.
  • Type: java.lang.String
  • Required: No
  • User Property: repositoryId
  • Default: remote-repository

<repositoryLayout>

The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout.
  • Type: java.lang.String
  • Required: Yes
  • User Property: repositoryLayout
  • Default: default

<sourceFolder>

Folder to be deployed.
  • Type: java.io.File
  • Required: Yes
  • User Property: sourceFolder

<uniqueVersion>

Whether to deploy snapshots with a unique version or not.
  • Type: boolean
  • Required: No
  • User Property: uniqueVersion
  • Default: true

<url>

URL where the artifact will be deployed.
ie ( file://C:\m2-repo or scp://host.com/path/to/repo )
  • Type: java.lang.String
  • Required: Yes
  • User Property: url

<useSameGroupIdAsArtifactId>

For not maven standard artifacts a new not mandatory parameter like useSameGroupIdAsArtifactId could be useful to avoid the awkwardness of regex groups matching artifactId and GroupId.
A thumb rule could be:
  • take all filename content after the last - and before file extension and manage it as a fallback to version parameter.
  • all content before the last - or before .jar identify both artifactId and GroupId.
Example: 
guava-19.0.jar

If version not set and useSameGroupIdAsArtifactId = true

   groupId:      guava
   artifactId:   guava
   version:      19.0

   if version set to xxx and useSameGroupIdAsArtifactId = true

   groupId:      guava-19.0
   artifactId:   guava-19.0
   version:      xxx
  • Type: boolean
  • Required: No
  • User Property: useSameGroupIdAsArtifactId
  • Default: false

<version>

Version of the artifact to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • User Property: version