deploy:deploy-file

Full name:

org.apache.maven.plugins:maven-deploy-plugin:2.6:deploy-file

Description:

Installs the artifact in the remote repository.

Attributes:

Required Parameters

Name Type Since Description
file File - File to be deployed.
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.
url String - URL where the artifact will be deployed.
ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )

Optional Parameters

Name Type Since Description
artifactId String - ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.
classifier String - Add classifier to the artifact
description String - Description passed to a generated POM file (in case of generatePom=true)
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.
groupId String - GroupId of the artifact to be deployed. Retrieved from POM file if specified.
javadoc File 2.6 The bundled API docs for the artifact.
packaging String - Type of the artifact to be deployed. Retrieved from POM file if specified. Defaults to file extension if not specified via command line or POM.
pomFile File - Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
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.
sources File 2.6 The bundled sources for the artifact.
uniqueVersion boolean - Whether to deploy snapshots with a unique version or not.
Default value is: true.
updateReleaseInfo boolean - Parameter used to update the metadata to make the artifact as release.
Default value is: false.
version String - Version of the artifact to be deployed. Retrieved from POM file if specified.

Parameter Details

artifactId:

ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • Expression: ${artifactId}

classifier:

Add classifier to the artifact
  • Type: java.lang.String
  • Required: No
  • Expression: ${classifier}

description:

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

file:

File to be deployed.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${file}

generatePom:

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

groupId:

GroupId of the artifact to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • Expression: ${groupId}

javadoc:

The bundled API docs for the artifact.
  • Type: java.io.File
  • Since: 2.6
  • Required: No
  • Expression: ${javadoc}

packaging:

Type of the artifact to be deployed. Retrieved from POM file if specified. Defaults to file extension if not specified via command line or POM.
  • Type: java.lang.String
  • Required: No
  • Expression: ${packaging}

pomFile:

Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
  • Type: java.io.File
  • Required: No
  • Expression: ${pomFile}

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: Yes
  • Expression: ${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: No
  • Expression: ${repositoryLayout}
  • Default: default

sources:

The bundled sources for the artifact.
  • Type: java.io.File
  • Since: 2.6
  • Required: No
  • Expression: ${sources}

uniqueVersion:

Whether to deploy snapshots with a unique version or not.
  • Type: boolean
  • Required: No
  • Expression: ${uniqueVersion}
  • Default: true

updateReleaseInfo:

Parameter used to update the metadata to make the artifact as release.
  • Type: boolean
  • Required: No
  • Expression: ${updateReleaseInfo}
  • Default: false

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
  • Expression: ${url}

version:

Version of the artifact to be deployed. Retrieved from POM file if specified.
  • Type: java.lang.String
  • Required: No
  • Expression: ${version}