install:install-file

Full name:

org.apache.maven.plugins:maven-install-plugin:2.3.1:install-file

Description:

Installs a file in the local repository.

Attributes:

  • Executes as an aggregator plugin.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
file File - The file to be installed in the local repository.
repositoryLayout String 2.2 The type of remote repository layout to install to. Try legacy for a Maven 1.x-style repository layout.
Default value is: default.

Optional Parameters

Name Type Since Description
artifactId String - ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified.
classifier String 2.2 Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
createChecksum boolean 2.2 Flag whether to create checksums (MD5, SHA-1) or not.
Default value is: false.
generatePom Boolean 2.1 Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
groupId String - GroupId of the artifact to be installed. Retrieved from POM file if one is specified.
javadoc File 2.3 The bundled API docs for the artifact.
localRepositoryPath File 2.2 The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
packaging String - Packaging type of the artifact to be installed. Retrieved from POM file if one is specified.
pomFile File 2.1 Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
sources File 2.3 The bundled sources for the artifact.
updateReleaseInfo boolean - Whether to update the metadata to make the artifact a release version.
Default value is: false.
version String - Version of the artifact to be installed. Retrieved from POM file if one is specified.

Parameter Details

artifactId:

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

classifier:

Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Expression: ${classifier}

createChecksum:

Flag whether to create checksums (MD5, SHA-1) or not.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${createChecksum}
  • Default: false

file:

The file to be installed in the local repository.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${file}

generatePom:

Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
  • Type: java.lang.Boolean
  • Since: 2.1
  • Required: No
  • Expression: ${generatePom}

groupId:

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

javadoc:

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

localRepositoryPath:

The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Expression: ${localRepositoryPath}

packaging:

Packaging type of the artifact to be installed. Retrieved from POM file if one is specified.
  • Type: java.lang.String
  • Required: No
  • Expression: ${packaging}

pomFile:

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

repositoryLayout:

The type of remote repository layout to install to. Try legacy for a Maven 1.x-style repository layout.
  • Type: java.lang.String
  • Since: 2.2
  • Required: Yes
  • Expression: ${repositoryLayout}
  • Default: default

sources:

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

updateReleaseInfo:

Whether to update the metadata to make the artifact a release version.
  • Type: boolean
  • Required: No
  • Expression: ${updateReleaseInfo}
  • Default: false

version:

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