Built by Maven

invoker:install

Full name:

org.apache.maven.plugins:maven-invoker-plugin:3.8.1:install

Description:

Installs the project artifacts of the main build into the local repository as a preparation to run the sub projects. More precisely, all artifacts of the project itself, all its locally reachable parent POMs and all its dependencies from the reactor will be installed to the local repository.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.2.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<localRepositoryPath> File - The path to the local repository into which the project artifacts should be installed for the integration tests. If not set, the regular local repository will be used. To prevent soiling of your regular local repository with possibly broken artifacts, it is strongly recommended to use an isolated repository for the integration tests (e.g. ${project.build.directory}/it-repo).
Default: ${session.localRepository.basedir}
User Property: invoker.localRepositoryPath

Optional Parameters

Name Type Since Description
<extraArtifacts> String[] 1.6 Extra dependencies that need to be installed on the local repository.

Format:

groupId:artifactId:version:type:classifier

Examples:

org.apache.maven.plugins:maven-clean-plugin:2.4:maven-plugin
org.apache.maven.plugins:maven-clean-plugin:2.4:jar:javadoc

If the type is 'maven-plugin' the plugin will try to resolve the artifact using plugin remote repositories, instead of using artifact remote repositories.

NOTICE all dependencies will be resolved with transitive dependencies in runtime scope.

<scope> String 3.5.0 Scope to resolve project artifacts.
Default: runtime
User Property: invoker.install.scope
<skipInstallation> boolean 1.4 A flag used to disable the installation procedure. This is primarily intended for usage from the command line to occasionally adjust the build.
Default: false
User Property: invoker.skip

Parameter Details

<extraArtifacts>

Extra dependencies that need to be installed on the local repository.

Format:

groupId:artifactId:version:type:classifier

Examples:

org.apache.maven.plugins:maven-clean-plugin:2.4:maven-plugin
org.apache.maven.plugins:maven-clean-plugin:2.4:jar:javadoc

If the type is 'maven-plugin' the plugin will try to resolve the artifact using plugin remote repositories, instead of using artifact remote repositories.

NOTICE all dependencies will be resolved with transitive dependencies in runtime scope.

  • Type: java.lang.String[]
  • Since: 1.6
  • Required: No

<localRepositoryPath>

The path to the local repository into which the project artifacts should be installed for the integration tests. If not set, the regular local repository will be used. To prevent soiling of your regular local repository with possibly broken artifacts, it is strongly recommended to use an isolated repository for the integration tests (e.g. ${project.build.directory}/it-repo).
  • Type: java.io.File
  • Required: Yes
  • User Property: invoker.localRepositoryPath
  • Default: ${session.localRepository.basedir}

<scope>

Scope to resolve project artifacts.
  • Type: java.lang.String
  • Since: 3.5.0
  • Required: No
  • User Property: invoker.install.scope
  • Default: runtime

<skipInstallation>

A flag used to disable the installation procedure. This is primarily intended for usage from the command line to occasionally adjust the build.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • User Property: invoker.skip
  • Default: false