Built by Maven

deploy:deploy-file

Full name:

org.apache.maven.plugins:maven-deploy-plugin:4.0.0-beta-1:deploy-file

Description:

Installs the artifact in the remote repository.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<file> Path - 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.
<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
<classifiers> String - A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or types, then an error will be raised.
<description> String - Description passed to a generated POM file (in case of generatePom=true)
<files> String - A comma separated list of files for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in types or classifiers, then an error will be raised.
<generatePom> boolean - Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.
<groupId> String - GroupId of the artifact to be deployed. Retrieved from POM file if specified.
<javadoc> Path 2.6 The bundled API docs for the artifact.
<packaging> String - Type of the artifact to be deployed. Retrieved from the <packaging> element of the POM file if a POM file specified. Defaults to the file extension if it is not specified via command line or POM.
Maven uses two terms to refer to this datum: the <packaging> element for the entire POM, and the <type> element in a dependency specification.
<pomFile> Path - Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
<retryFailedDeploymentCount> int 2.7 Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10.
<skip> String 3.1.0 Set this to 'true' to bypass artifact deploy It's not a real boolean as it can have more than 2 values:
  • true: will skip as usual
  • releases: will skip if current version of the project is a release
  • snapshots: will skip if current version of the project is a snapshot
  • any other values will be considered as false
<sources> Path 2.6 The bundled sources for the artifact.
<types> String - A comma separated list of types for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or classifiers, then an error will be raised.
<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

<classifier>

Add classifier to the artifact
  • Type: java.lang.String
  • Required: No

<classifiers>

A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or types, then an error will be raised.
  • Type: java.lang.String
  • Required: No

<description>

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

<file>

File to be deployed.
  • Type: java.nio.file.Path
  • Required: Yes

<files>

A comma separated list of files for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in types or classifiers, then an error will be raised.
  • Type: java.lang.String
  • Required: No

<generatePom>

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

<groupId>

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

<javadoc>

The bundled API docs for the artifact.
  • Type: java.nio.file.Path
  • Since: 2.6
  • Required: No

<packaging>

Type of the artifact to be deployed. Retrieved from the <packaging> element of the POM file if a POM file specified. Defaults to the file extension if it is not specified via command line or POM.
Maven uses two terms to refer to this datum: the <packaging> element for the entire POM, and the <type> element in a dependency specification.
  • Type: java.lang.String
  • Required: No

<pomFile>

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

<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

<retryFailedDeploymentCount>

Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10.
  • Type: int
  • Since: 2.7
  • Required: No

<skip>

Set this to 'true' to bypass artifact deploy It's not a real boolean as it can have more than 2 values:
  • true: will skip as usual
  • releases: will skip if current version of the project is a release
  • snapshots: will skip if current version of the project is a snapshot
  • any other values will be considered as false
  • Type: java.lang.String
  • Since: 3.1.0
  • Required: No

<sources>

The bundled sources for the artifact.
  • Type: java.nio.file.Path
  • Since: 2.6
  • Required: No

<types>

A comma separated list of types for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or classifiers, then an error will be raised.
  • Type: java.lang.String
  • Required: No

<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

<version>

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