A Maven core extension (lifecycle participant) which adds dependency management features to Maven to allow dependency and plugin versions to be overridden using a command line property.
| WARNING : This extension has been deprecated and its functionality rolled into https://github.com/release-engineering/pom-manipulation-ext. |
If any of the extension's options are used, the results are recorded in .properties format in META-INF/maven/groupId/artifactId/, the same place that maven copies the normal pom file to. An "effective pom" representation of the post-modification pom model is also written to this directory. These actions help mitigate loss of build repeatability.
This extension is compatible with Maven 3. It has not been tested with Maven 2.x and will likely not work correctly.
The extension jar can be downloaded from a Maven repository, or it can be built from source. Once the jar is downloaded, it must be added to the directory ${MAVEN_HOME}/lib/ext. The next time Maven is started, you should see a command line message showing that the extension has been installed.
[INFO] Init Maven Dependency Management Extension 1.0.0
If you wish to remove the extension after installing it, remove the jar from the lib/ext directory:
rm ${MAVEN_HOME}/lib/ext/maven-dependency-management-extension*.jar
As an alternative to installing the extension into your Maven installation, you can activate Maven Dependency Management Extension for a single project by adding this to your pom.xml (fill in VERSION, eg 1.0.1):
<build>
<extensions>
<extension>
<groupId>org.jboss.maven.extension.dependency</groupId>
<artifactId>maven-dependency-management-extension</artifactId>
<version>VERSION</version>
</extension>
</extensions>
</build>
Dependency and plugin versions are overridden using command line system properties.
The version of a specific dependency can be overridden using a command line property of the form "version:[groupId]:[artifactId]=[version]".
For example, the version of junit can be set to 4.10 using a command line property.
mvn install -Dversion:junit:junit=4.10
Multiple version overrides can be performed using multiple command line properties.
mvn install -Dversion:junit:junit=4.10 -Dversion:commons-logging:commons-logging=1.1.1
If a large set of versions needs to be overridden, or the dependencies of the current project need to be tested with a matching set of dependencies from another project, a remote dependency management pom can be specified.
mvn install -DdependencyManagement=org.foo:my-dep-pom:1.0
This has the effect of taking the <dependencyManagement/> from the remote pom, and applying the dependency versions to the current build. By default, all dependencies listed in the remote pom will be added to the current build. This has the effect of overriding matching transitive dependencies, as well as those specified directly in the pom. If transitive dependencies should not be overridden, the option "overrideTransitive" can be set to false.
mvn install -DdependencyManagement=org.foo:my-dep-pom:1.0 -DoverrideTransitive=false
As of version 1.1.0, multiple remote dependency management poms can be specified using a comma separated list of GAVs (groupId, artifactId, version). The poms are specified in order of priority, so if the remote boms contain some of the same dependencies, the versions listed in the first bom in the list will be used.
mvn install -DdependencyManagement=org.foo:my-dep-pom:1.0,org.bar:my-dep-pom:2.0
In a multi-module build it is considered good practice to coordinate dependency version among the modules using dependency management. In other words, if module A and B both use dependency X, both modules should use the same version of dependency X. Therefore, the default behaviour of this extension is to use a single set of dependency versions applied to all modules.
However, there are certain cases where it is useful to use different versions of the same dependency in different modules. For example, if the project includes integration code for multiple versions of a particular API. In that case, it is possible to apply a version override to a specific module of a multi-module build.
mvn install -Dversion:[groupId]:[artifactId]@[moduleGroupId]:[moduleArtifactId]=[version]
For example to apply a dependency override only to module B of project foo.
mvn install -Dversion:junit:junit@org.foo:moduleB=4.10
It is also possible to prevent overriding dependency versions on a per module basis:
mvn install -Dversion:[groupId]:[artifactId]@[moduleGroupId]:[moduleArtifactId]=
For example
mvn install -Dversion:junit:junit@org.foo:moduleB=
Plugin versions can be overridden in the pom using a similar pattern to dependencies with the format "pluginVersion:[groupId]:[artifactId]=[version]".
mvn install -DpluginVersion:org.apache.maven.plugins:maven-compiler-plugin=3.0
To override more than one Maven plugin version, multple override properties can be specified on the command line, or a remote plugin management pom can be specified.
mvn install -DpluginManagement=org.jboss:jboss-parent:10
This will apply all <pluginManagement/> versions from the remote pom, to the local pom. Multiple remote plugin management poms can be specified on the command line using a comma separated list of GAVs. The first pom specified will be given the highest priority if conflicts occur.
mvn install -DpluginManagement=org.company:pluginMgrA:1.0,org.company:pluginMgrB:2.0
The extensions may also be used to override properties prior to interpolating the model. This requires the extension to be installed in lib/ext. Multiple property mappings can be overridden using a similar pattern to dependencies via a remote property management pom.
mvn install -DpropertyManagement=org.foo:property-management:10
Properties may be overridden on the command line as per normal Maven usage (i.e. -Dversion.org.foo=1.0)
The extension will automatically set properties which match the version overrides. These properties can be used, for example, in resource filtering in the build. By default the extension will set a property following the format "version:[groupId]:[artifactId]=[version]" for each overridden dependency. The format of this property can be customized using command line system properties.
versionPropertyPrefix - Defaults to "version:"
versionPropertyGASeparator - Defaults to ":"
versionPropertySuffix - Defaults to empty string ""
For example, the version property format could be set to "my.[groupId]_[artifactId].version=[version]"
mvn install -DversionPropertyPrefix="my." -DversionPropertyGASeparator="_" -DversionPropertySuffix=".version"
You must have Maven 3 or higher installed to build the extension. The source repository can be downloaded from github.
git clone git://github.com/jboss/maven-dependency-management-extension.git
After cloning the repo, just run a normal maven build.
mvn install
The extension jar is created in the target directory.
The following command runs the integration tests as part of the build
mvn install -Prun-its
The plugin management feature will override plugin versions, but this will not work on plugins which are configured as build extensions.
<extensions>true</extensions>
These plugins are loaded early in the build lifecycle, before the dependency management extension takes effect.
Some Maven builds configure a plugin with additional dependencies. This is common in the maven-antrun-plugin for example when using non-default tasks/features of Ant. This extension does not currently allow these dependencies to be overridden from the command line.
It is common in a multi-module Maven build that one module has a dependency on another module. If the remote dependency management pom contains overrides for the modules of the current project, Maven will attempt to use the override versions instead of the local versions. In version 1.0.1 of this extension, a change was made to cause the overrides to ignore dependencies that are in the current reactor, however this problem could still occur when attempting to build a single module of a multi-module build.