deploy:deploy-file

Installs the artifact in the remote repository.

Mojo Attributes:

    Required Parameters

    Name Type 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.
    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.
    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 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.
    packaging String Type of the artifact to be deployed. Retrieved from POM file if specified.
    pomFile File Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
    uniqueVersion boolean Whether to deploy snapshots with a unique version or not. Default value is true.
    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}
    packaging Type of the artifact to be deployed. Retrieved from POM file if specified.
    • 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: Yes
    • Expression: ${repositoryLayout}
    • Default: default
    uniqueVersion Whether to deploy snapshots with a unique version or not.
    • Type: boolean
    • Required: No
    • Expression: ${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
    • Expression: ${url}
    version Version of the artifact to be deployed. Retrieved from POM file if specified.
    • Type: java.lang.String
    • Required: No
    • Expression: ${version}