In Gradle, how can I generate a POM file with dynamic dependencies resolved to the actual version used?
dependencies { testCompile(group: 'junit', name: 'junit', version: '4.+') }
This is generated from the dependency above.
junitjunit4.+test
I want to have the +
resolved to an accrual version like below.
junitjunit4.12test
The Gradle guide chapter on Maven Publishing talks about doing this, but does not mention how.
With this hook, you can modify any aspect of the POM. For example, you could replace the version range for a dependency with the actual version used to produce the build.
Solution
Using the information in Peter Niederwieser's answer, I created a task that reads a POM that contains dynamic dependencies and overwrites it with a new pom that has the dependencies resolved.
/** * Reads and Overwrites POM file resolving dynamic dependencies */ task cleanPom(dependsOn: writeNewPom) resolvedArtifacts = configurations.compile.getResolvedConfiguration().getResolvedArtifacts() resolvedArtifacts.addAll(configurations.testCompile.getResolvedConfiguration().getResolvedArtifacts()) resolvedArtifacts.each { resolvedVersionMap.put(it.getName(), it.getModuleVersion().getId().getVersion()) } // Update dependencies with resolved versions xml.dependencies.first().each { Node artifactId = it.get("artifactId").first() def artifactName = artifactId.value().first() def artifactVersion = resolvedVersionMap.get(artifactName) Node version = it.get("version").first() version.value = artifactVersion } // Overwrite existing pom file new XmlNodePrinter(new PrintWriter(new FileWriter(pomFileLocation))).print(xml) }
It will require some effort to code this up. The two main parts are:
- Querying resolved versions using the
Configuration#getIncoming
or Configuration#getResolvedConfiguration
API - Manipulating the POM using Groovy's
XMlParser
API (assuming the new maven-publish
plugin is used)
Information about the Configuration
API can be found in the Gradle Build Language Reference, which further links into the Javadoc. The full Gradle distribution contains a tiny sample that demonstrates POM manipulation. Information about XmlParser
can be found in the Groovy docs.
I've taken a stab at integrating this into a plugin that can be applied, the specific code is available here: https://github.com/nebula-plugins/nebula-publishing-plugin/blob/master/src/main/groovy/nebula/plugin/publishing/maven/ResolvedMavenPlugin.groovy
And it can be included via jcenter() via 'com.netflix.nebula:nebula-publishing-plugin:1.9.1'.
The solution with the pom.withXml()
suggested by Peter looks like this:
publishing { publications { mavenCustom(MavenPublication) { from components.java pom.withXml { // Generate map of resolved versions Map resolvedVersionMap = [:] Set resolvedArtifacts = configurations.compile.getResolvedConfiguration().getResolvedArtifacts() resolvedArtifacts.addAll(configurations.testCompile.getResolvedConfiguration().getResolvedArtifacts()) resolvedArtifacts.each { ModuleVersionIdentifier mvi = it.getModuleVersion().getId(); resolvedVersionMap.put("${mvi.getGroup()}:${mvi.getName()}", mvi.getVersion()) } // Update dependencies with resolved versions def hasDependencies = !asNode().dependencies.isEmpty() if (hasDependencies) { asNode().dependencies.first().each { def groupId = it.get("groupId").first().value().first() def artifactId = it.get("artifactId").first().value().first() it.get("version").first().value = resolvedVersionMap.get("${groupId}:${artifactId}") } } } } }