install:install-file
Full name:
org.apache.maven.plugins:maven-install-plugin:4.0.0-beta-2:install-file
Description:
Installs a file in the local repository.
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator goal.
- The goal is not marked as thread-safe and thus does not support parallel builds.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<file> |
Path |
- |
The file to be installed in the local repository. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<artifactId> |
String |
- |
ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available. |
<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. |
<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 or extracted from pom.xml in jar if available. |
<javadoc> |
Path |
2.3 |
The bundled API docs for the artifact. |
<localRepositoryPath> |
Path |
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 or extracted from pom.xml in jar if available. |
<pomFile> |
Path |
2.1 |
Location of an existing POM file to be installed alongside the main artifact, given by the file parameter. |
<sources> |
Path |
2.3 |
The bundled sources for the artifact. |
<version> |
String |
- |
Version of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available. |
Parameter Details
<artifactId>
ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from
pom.xml in jar if available.- Type:
java.lang.String - Required:
No
<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
<file>
The file to be installed in the local repository.
- Type:
java.nio.file.Path - Required:
Yes
<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
<groupId>
GroupId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from
pom.xml in jar if available.- Type:
java.lang.String - Required:
No
<javadoc>
The bundled API docs for the artifact.
- Type:
java.nio.file.Path - Since:
2.3 - Required:
No
<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.nio.file.Path - Since:
2.2 - Required:
No
<packaging>
Packaging type of the artifact to be installed. Retrieved from POM file if one is specified or extracted from
pom.xml in jar if available.- Type:
java.lang.String - Required:
No
<pomFile>
Location of an existing POM file to be installed alongside the main artifact, given by the
file parameter.- Type:
java.nio.file.Path - Since:
2.1 - Required:
No
<sources>
The bundled sources for the artifact.
- Type:
java.nio.file.Path - Since:
2.3 - Required:
No
<version>
Version of the artifact to be installed. Retrieved from POM file if one is specified or extracted from
pom.xml in jar if available.- Type:
java.lang.String - Required:
No