mvn:mvn

Full name:

org.kuali.maven.plugins:mvn-maven-plugin:1.1.1:mvn

Description:

Invoke mvn from Maven.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
args List - Arguments to supply to the new mvn invocation eg "clean install"
basedir File - The base directory for the new mvn invocation.
Default value is: ${project.build.directory}/mvn.
User property is: mvn.basedir.
deleteTempPom boolean - If true, any temp pom copied to basedir will be deleted when the plugin execution is complete
Default value is: true.
User property is: mvn.deleteTempPom.
failOnError boolean - If true, the original Maven build will fail if the new mvn invocation returns a non-zero exit value, otherwise the original Maven build will continue
Default value is: true.
User property is: mvn.failOnError.
forceMojoExecution boolean - If true, always execute the mojo, even if packaging is pom. forceMojoExecution overrides skip
Default value is: false.
User property is: mvn.forceMojoExecution.
quiet boolean - If true, logging output is reduced to a minimum
Default value is: true.
User property is: mvn.quiet.
silent boolean - If true, no logging output is generated.
Default value is: false.
User property is: mvn.silent.
skip boolean - If true, skip executing the mojo
Default value is: false.
User property is: mvn.skip.
workingDir File - The working directory where the plugin makes a local copy of the pom (if a pom is supplied)
Default value is: ${project.build.directory}/mvn.
User property is: mvn.workingDir.

Optional Parameters

Name Type Since Description
addEnvironment boolean - If true, the current environment is passed to the new mvn invocation
Default value is: false.
User property is: mvn.addEnvironment.
addMavenOpts boolean - If true, the environment variable MAVEN_OPTS (if set) is passed to the new mvn invocation
Default value is: true.
User property is: mvn.addMavenOpts.
executable String - The Maven executable. By default, the executable to use is located via the ${maven.home} system property. This causes the new mvn invocation to mirror the one that is currently executing (same version, etc). You can override this behavior by supplying your own executable
User property is: mvn.executable.
filterPom boolean - If true, the pom will be filtered using properties from the current project before being invoked
Default value is: false.
User property is: mvn.filterPom.
filterProperties List - If supplied, only the listed properties will be used when filtering the pom
pom String - The pom to supply to the new mvn invocation. This can be a file or any url Spring resource loading can understand eg classpath:pom.xml
User property is: mvn.pom.
poms List - POM's to invoke. If supplied, a new Maven invocation is generated using the same args for each pom
properties List - List of properties from the current project to propagate to the new mvn invocation

Parameter Details

addEnvironment:

If true, the current environment is passed to the new mvn invocation
  • Type: boolean
  • Required: No
  • User Property: mvn.addEnvironment
  • Default: false

addMavenOpts:

If true, the environment variable MAVEN_OPTS (if set) is passed to the new mvn invocation
  • Type: boolean
  • Required: No
  • User Property: mvn.addMavenOpts
  • Default: true

args:

Arguments to supply to the new mvn invocation eg "clean install"
  • Type: java.util.List
  • Required: Yes

basedir:

The base directory for the new mvn invocation.
  • Type: java.io.File
  • Required: Yes
  • User Property: mvn.basedir
  • Default: ${project.build.directory}/mvn

deleteTempPom:

If true, any temp pom copied to basedir will be deleted when the plugin execution is complete
  • Type: boolean
  • Required: Yes
  • User Property: mvn.deleteTempPom
  • Default: true

executable:

The Maven executable. By default, the executable to use is located via the ${maven.home} system property. This causes the new mvn invocation to mirror the one that is currently executing (same version, etc). You can override this behavior by supplying your own executable
  • Type: java.lang.String
  • Required: No
  • User Property: mvn.executable

failOnError:

If true, the original Maven build will fail if the new mvn invocation returns a non-zero exit value, otherwise the original Maven build will continue
  • Type: boolean
  • Required: Yes
  • User Property: mvn.failOnError
  • Default: true

filterPom:

If true, the pom will be filtered using properties from the current project before being invoked
  • Type: boolean
  • Required: No
  • User Property: mvn.filterPom
  • Default: false

filterProperties:

If supplied, only the listed properties will be used when filtering the pom
  • Type: java.util.List
  • Required: No

forceMojoExecution:

If true, always execute the mojo, even if packaging is pom. forceMojoExecution overrides skip
  • Type: boolean
  • Required: Yes
  • User Property: mvn.forceMojoExecution
  • Default: false

pom:

The pom to supply to the new mvn invocation. This can be a file or any url Spring resource loading can understand eg classpath:pom.xml
  • Type: java.lang.String
  • Required: No
  • User Property: mvn.pom

poms:

POM's to invoke. If supplied, a new Maven invocation is generated using the same args for each pom
  • Type: java.util.List
  • Required: No

properties:

List of properties from the current project to propagate to the new mvn invocation
  • Type: java.util.List
  • Required: No

quiet:

If true, logging output is reduced to a minimum
  • Type: boolean
  • Required: Yes
  • User Property: mvn.quiet
  • Default: true

silent:

If true, no logging output is generated.
  • Type: boolean
  • Required: Yes
  • User Property: mvn.silent
  • Default: false

skip:

If true, skip executing the mojo
  • Type: boolean
  • Required: Yes
  • User Property: mvn.skip
  • Default: false

workingDir:

The working directory where the plugin makes a local copy of the pom (if a pom is supplied)
  • Type: java.io.File
  • Required: Yes
  • User Property: mvn.workingDir
  • Default: ${project.build.directory}/mvn