Gradle POM plugin

About

Plugin simplifies maven-publish plugin usage and corrects generated pom.

Plugin should make gradle more familiar for maven users (at least simpler to use). With it, multi-module projects could be organized the same way as maven projects: all dependencies managed in the root project (and, optionally, published as bom).

Features:

Fix dependencies scopes in the generated pom
- Fix war plugin's provided dependencies
Add provided and optional configuration (in maven meaning).
Add global pom configuration shortcuts (applied to all publications):
- maven.pom type-safe pom configuration (same as in publication object)
- maven.pomXml configuration closure (applied to all publications).
- maven.withPomXml configuration closure for manual xml modifications (same as maven-publish's withXml, but applied for all publications)
Moves declared BOMs on top in the generated dependencyManagement section (fixes java-platform behaviour)
Automatic pom enhancements could be disabled to see the native gradle behaviour)
Optionally, could remove used BOMs, applying resolved versions instead (useful with gradle platforms to simplify resulted poms)
Simplifies multi-module projects configuration
Easy debug (could show all applied modifications)
Compatible with:
- Gradle java, groovy and java-library plugin
- Gradle java-platform plugin (BOM case)
- Spring dependency-management plugin

If you develop java or groovy library you may look at java-lib plugin which already includes this plugin and configures maven publication for you (don't confuse with gradle's java-library plugin which only declares api and implementation configurations).

If your project is hosted on github you may look at github-info plugin which fills some pom sections for you automatically.

Also, you can use java-library generator to setup new project with all plugins configured.

Summary

Configuration closure: maven
Configurations: provided, optional
Enable plugins: maven-publish

Setup

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath 'ru.vyarus:gradle-pom-plugin:3.0.0'
    }
}
apply plugin: 'ru.vyarus.pom'

OR

plugins {
    id 'ru.vyarus.pom' version '3.0.0'
}

Compatibility

Plugin compiled for java 8, compatible with java 17.

Gradle	Version
7.0	3.0.0
5.0	[2.2.2]((https://github.com/xvik/gradle-pom-plugin/tree/2.2.2)
4.6	1.3.0
older	1.2.0

Snapshots

Snapshots may be used through JitPack

Go to JitPack project page
Select Commits section and click Get it on commit you want to use (you may need to wait while version builds if no one requested it before) or use master-SNAPSHOT to use the most recent snapshot

Add to settings.gradle (top most!) (exact commit hash might be used as version):

pluginManagement {
    resolutionStrategy {
        eachPlugin {
            if (requested.id.id == 'ru.vyarus.pom') {
                useModule('ru.vyarus:gradle-pom-plugin:master-SNAPSHOT')
            }
        }
    }
    repositories {                        
        gradlePluginPortal()
        maven { url 'https://jitpack.io' }                    
    }
}

Use plugin without declaring version:
```
plugins {
    id 'ru.vyarus.pom'
}
```

Usage

NOTE: in version 3.0 old conventions were replaced by configuration extension - see migration guide

If java, groovy, java-library or java-platform plugins enabled, maven-publish would be registered automatically. For example:

plugins {
    id 'java' // or groovy or java-library
    id 'ru.vyarus.pom'
}

plugins {
    id 'java-platform'
    id 'ru.vyarus.pom'
}

in both cases maven-publish plugin would be activated implicitly.

Configuration closures added when maven-publish plugin registered (and so will be available even if you don't use java plugins above and only register maven-publish manually).

For example the following is also a valid usage:

plugins {
    id 'maven-publish'
    id 'ru.vyarus.pom'
}

Publication must be configured manually, for example:

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java
        }
    }
}

(see java-lib plugin for automatic publication registration)

Maven scopes reference:

Maven scope	Gradle configuration
compile	implementation, api
runtime	runtimeOnly
provided	provided (not compileOnly!)
optional	optional, feature variants

Also, see good article describing maven/gradle scope analogies.

compileOnly should be used only for compile-time only dependencies like nullability annotations.

api configuration appear only when java-library plugin is enabled. Read this article to better understand api-implementation difference for gradle (or simply use implementaion by default).

Dependencies

Plugin fixes dependencies scopes in the generated pom:

Configuration	Fixed scope	Native behaviour	Note
api	compile	compile	ony with java-library plugin
implementation	compile	runtime
compileOnly	-	dependencies not added
runtimeOnly	runtime	runtime
providedCompile	provided	compile	only with war plugin
providedRuntime	provided	compile	only with war plugin

Note: in context of gradle java-library plugin, both api and implementation dependencies stored in pom as compile dependencies because there is only build time difference (it's a gradle optimization) between configurations and module still need implementation dependencies. For the end user they both are usual transitive dependencies and must have compile scope.

For example:

plugins {
    id: 'java'
    id 'ru.vyarus.pom'
}
dependencies {    
    implementation 'com.foo:dep-compile:1.0'
    runtimeOnly 'com.foo:dep-runtime:1.0'
    provided 'com.foo:dep-provided:1.0'
    optional 'com.foo:dep-optional:1.0' 
}

Will result in:

<dependencies>
     <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-compile</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-runtime</artifactId>
        <version>1.0</version>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-provided</artifactId>
        <version>1.0</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-optional</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
        <optinoal>true</optinoal>
    </dependency>
</dependencies>

And

plugins {
    id: 'java-library'
    id 'ru.vyarus.pom'
}
dependencies {    
    implementation 'com.foo:dep-compile:1.0'
    api 'com.foo:dep-api-compile:1.0'        
}

Will produce:

<dependencies>
     <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-compile</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>com.foo</groupId>
        <artifactId>dep-api-compile</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

NOTE: scope modifications could be disabled with pomGeneration section (see below)

Provided dependencies

Provided dependencies assumed to be present in target environment or already exists in projects consuming library. Provided dependencies will not be loaded as transitive dependencies, they will exist in pom just for consultation.

Additional provided configuration created for provided dependencies. Gradle implementation extends from it so for gradle provided dependencies would be the same as implementation and the difference will only appear in the resulted pom.

compileOnly

Gradle states that compileOnly is the official gradle analog for maven provided scope. But it's not: first of all, gradle does not add such dependencies to pom at all. More importantly, compileOnly dependencies are not visible in other scopes. So, for example, to use these dependencies in test, you'll have to add them again in test scope.

The only application for compileOnly scope is compile-time libraries, like nullability annotations.
This is not a provided scope.

Plugin does not do anything with compileOnly: these dependencies will not be present in the resulted pom.

Make other scopes as provided

If you already have some other scope and want to identify its dependencies in pom as provided then:

configurations.provided.extendsFrom configurations.apt

dependencies {
    implementation 'com.google.code.gson:gson:2.6.2'

    apt 'org.immutables:gson:2.1.19'
}

Suppose apt configuration was added by some plugin. Now, apt dependencies will be marked provided in the resulted pom:

 <dependencies> 
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.6.2</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.immutables</groupId>
        <artifactId>gson</artifactId>
        <version>2.1.19</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

War plugin

Gradle war plugin declares it's own provided configurations providedCompile and providedRuntime and these dependencies are not going into resulted war, but contained in the generated pom as compile. Plugin fixes such dependencies scope to provided (how it could be declared in pure maven).

Optional dependencies

Optional dependencies supposed to be used for not required dependencies, for example, activating additional features.

Additional optional configuration created for optional dependencies. Gradle implementation extends from it so for gradle optional dependencies would be the same as implementation and the difference will only appear in the resulted pom.

Feature variants

Gradle states that native replacement for optional dependencies is gradle feature variants. For example:

java {
    registerFeature('someFeature') {
        usingSourceSet(sourceSets.main)
    }     
}

dependencies {                                                       
    someFeatureImplementation 'com.google.code.findbugs:annotations:3.0.0'                
}

<dependencies>
    <dependency>
      <groupId>com.google.code.findbugs</groupId>
      <artifactId>annotations</artifactId>
      <version>3.0.0</version>
      <scope>compile</scope>
      <optional>true</optional>
    </dependency>
</dependencies>

Looks good, but these dependencies will not work as you expect from optionals: these dependencies will not be visible in other scopes. So if you need to test this behavior then you'll have to add another dependency in test scope.

Probably, there is a way to workaround this, but, still, simple things must be done simple, so optional configuration would just do what the majority of library developers need.

Pom configuration

By default, maven-publish plugin fills pom only with dependencies and artifact id, group and version. Other information could be configured through pom object:

maven {
    pom {
        name = 'Project Name'
        description = 'My awesome project'
        licenses {
            license {
                name = "The MIT License"
                url = "http://www.opensource.org/licenses/MIT"
                distribution = 'repo'
            }
        }
        scm {
            url = 'https://github.com/me/my-repo.git'
            connection = 'scm:[email protected]:me/my-repo.git'
            developerConnection = 'scm:[email protected]:me/my-repo.git'
        }
        developers {
            developer {
                id = "dev1"
                name = "Dev1 Name"
                email = "[email protected]"
            }
        }
    }
}

NOTE: this is type-safe pom configuration (compatible with kotlin). The same object used as in direct publication configuration, but this one is applied to all publications. Pay attention that = used for assignments.

Non-standard pom tags

In the option above, only pre-defined properties could be applied, but if you need (for whatever reason) to add some custom tags, then you can use groovy closure:

maven {
    pomXml {
        name 'Project Name'
        description 'My awesome project'
        licenses {
            license {
                name "The MIT License"
                url "http://www.opensource.org/licenses/MIT"
                distribution 'repo'
            }
        }
        whateverTag 'something'
        whateverSection {
            whateverElse 12 
        }
    }
}

Closure doesn't restrict structure: any tags may be used.

NOTE: for pomXml groovy closure is used and so all properties configured with a method call: it would be a mistake to use = there.

Here is a complete example of all possible maven pom sections definition (you can use any tags if needed, not just these).

INFO: pomXml option is a legacy plugin mechanism (developed in times when maven-publish plugin does not provide anything except direct pom modification). Before pom plugin version 3.0 this was the main configuration (applied with pom convention)

Duplicate xml sections detection

Groovy closure (pomXml) could also be useful when you want to avoid duplicates.

For example, static model would always apply specified sections:

maven.pom {
    developers {
        developer {
            id = 'test'
            name = 'Test Test'
        }
    }
}

maven.pom {
    developers {
        developer {
            id = 'test'
            name = 'Test Test'
        }
    }
}

This would produce duplicate in the resulted xml:

<developers>
    <developer>
        <id>test</id>
        <name>Test Test</name>
    </developer>
    <developer>
        <id>test</id>
        <name>Test Test</name>
    </developer>
</developers>

Whereas groovy closure:

maven.pomXml {
    developers {
        developer {
            id 'test'
            name 'Test Test'
        }
    }
}

maven.pomXml {
    developers {
        developer {
            id 'test'
            name 'Test Test'
        }
    }
}

Would correctly detect duplication and the resulted xml would be:

<developers>
    <developer>
        <id>test</id>
        <name>Test Test</name>
    </developer>
</developers>

It is a very rare requirement to avoid duplications (appeared when pom is configured from multiple places), but still could appear, and, in this case, groovy closue (pomXml) could be very useful.

Clashed tag names

As pomXml closure is normal groovy closure, you may face situations when tag name clash with some method in your gradle project.

By default, there is only one such case:

maven.pomXml {
    parent {
        name 'name'
        relativePath 'path'
    }
}

relativePath tag will not be present in resulted pom, because it clashes with gradle Project.relativePath method and it will be called instead of "just holding" tag name.

Special prefix '_' may be used in such cases:

maven.pomXml {
    parent {
        name 'name'
        _relativePath 'path'
    }
}

This prefix will solve clash with real method and will be dropped during xml generation. You can use this prefix with any tag.

Another (standard) solution for this problem is using delegate reference: delegate.relativePath. But, for me, solution with prefix is simpler and easier to read.

Defaults

If name and description not specified, they will be applied implicitly from project.name and project.description.

If pom already have some tags (e.g. set manually with withXml or by some plugin), plugin will override values and properly merge pom. No duplicate tags will be created.

Multiple pom, pomXml (and withPomXml) configurations may be defined (useful for multi-module projects).

If multiple publications declared, then pom configuration will affect all of them. If you need different data in poms then use pom closure only for general info and gradle native dsl for different parts.

Testing

To test resulted pom you can use pom generation task:

$ gradlew generatePomFileForMavenJavaPublication

Note that 'MavenJava' in task name is publication name and in your case task name could be different.

Pom will be generated by default in build/publications/mavenJava/pom-default.xml

Manual pom modification

If, for any reason, you need to modify pom manually (like in withXml closure) you can use withPomXml configuration action:

maven {
    pom {
        scm {
            url = 'https://github.com/me/my-repo.git'
            connection = 'scm:[email protected]:me/my-repo.git'
            developerConnection = 'scm:[email protected]:me/my-repo.git'
        }
    }

    withPomXml {
        asNode().appendNode('description', 'A demonstration of maven POM customization')
    }
}

withPomXml action is exactly the same as withXml in publication

See Node api and groovy xml guide.

Multiple withPomXml actions could be used (useful for multi-module projects).

withPomXml called after pom and withPom actions merging into main pom, but before applying default name and description (because you may define them manually). So xml Node passed into closure contains all modification applied by the plugin (except default name and description).

NOTE pom plugin uses withXml to apply pom modifications. If other plugins use withXml too and these plugins registered after pom plugin, then their xml modification will be executed after pom plugin and after withPomXml block. Most likely, this will not be an issue, but just keep it in mind when using manual xml modifications.

Pom configurations order

Pom could be modified within publication (maven-publish plugin pom and withXml) and withing 3 blocks in pom plugin: maven.pom, maven.withPom and maven.withPomXml:

publishing {
    publications {
        maven(MavenPublication) {
            from components.java  

            // (1)
            pom {
               ...
            }

            // (2)
            pom.withXml {
                ...
            }
        }
    }
}

maven {
    // (3)
    pom {
        ...
    }
    // (4)
    withPom {
        ...
    }
    // (5)
    withPomXml {
        ...
    }
}

Configuration order:

Publication pom (static) (1)
Plugin static pom (3)
Publication withXml (2)
Plugin withPom (4)
Plugin withPomXml (5)

The reason for this is: (1) and (3) are static model changes (which are then generated into xml node), so they execute earlier.

(4) and (5) are applied within publication withXml block and so couldn't be execured before withXml declared directly within publication (2).

Pom generation options

Plugin behaviour could be controlled with maven configuration's methods.

For example, to disable scopes correction:

maven {
    disableScopesCorrection()
}

(you may use it to see the default gradle behaviour)

All options:

disableScopesCorrection() - disable dependencies scopes correction (to see native gradle behaviour)
disableBomsReorder() - disable moving declared BOMs on top of dependencyManagement section (to see native gradle behaviour)
forceVersions() - always put dependency version, even when platforms or BOM with spring plugin used (use recommended gradle way to force version)
removeDependencyManagement() - removes dependencyManagement section from the generated pom and implicitly activates forceVersions() (otherwise pom could become invalid). Useful with gradle platforms (see examples below)

(if you prefer property style declaration then you can use extension fields instead of methods (names differ from methods!): forcedVersions, removedDependencyManagement, disabledScopesCorrection (e.g. pomGeneration.forcedVersions = true))

Improving BOMs usage

If you use BOMs for dependency management:

dependencies {
    // declare BOM
    implementation platform('com.group:some-bom:1.0')
    // dependency version managed by BOM
    implementation 'com.other.group:some-dep'
}

(could be spring plugin instead of platform, behaviour is the same)

The resulted pom would look like (native behavior):

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.group</groupId>
            <artifactId>some-bom</artifactId>
            <version>1.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>com.other.group</groupId>
        <artifactId>some-dep</artifactId>
        <scope>compile</scope>
    </dependency>
</dependencies>

Note that dependency version is not set (assuming resolution through bom).

In order to force dependency versions use:

maven {
    forceVersions()
}

To completely remove dependency management section from generated pom:

maven {
    removeDependencyManagement()
}

the resulted pom would become:

<dependencies>
    <dependency>
        <groupId>com.other.group</groupId>
        <artifactId>some-dep</artifactId>
        <version>1.0</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

Gradle platforms are very handy for dependency management in the root project (maven style), but they should not "leak" into resulted poms. See the complete multi-module declaration example below.

Gradle pom dsl

Plugin was initially created when pom declaration in maven-publish plugin was clumsy, but since gradle 4.8 you can use dsl like in pom plugin in raw gradle:

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
            // native gradle syntax!
            pom {
                name = 'first'
                scm {
                  url = "http://subversion.example.com/svn/project/trunk/"
                }
            }
        }
    }
}

So why use pom plugin now?

Because maven publication configuration could be moved to external plugin (like ru.vyarus.java-lib which configures maven-compatible publication artifacts) and, in this case, only pom should be customized:

plugins {
    id 'ru.vyarus.java-lib'
}

maven.pom {
    name = 'first'
    scm {
      url = "http://subversion.example.com/svn/project/trunk/"
    }
}

Also, pom plugin applies pom declaration to all registered maven publications which is useful, for example, for gradle plugin where publication is prepared by closed source plugin.

If pom plugin used together with gradle dsl then pom plugin will merge its configuration into dsl:

plugins {
    id 'ru.vyarus.pom'
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
            // native gradle syntax!
            pom {
                name = 'first'
                description = 'desc'
                scm {
                  connection = "scm:svn:http://subversion.example.com/svn/project/trunk/"
                  url = "http://subversion.example.com/svn/project/trunk/"
                }
            }
        }
    }
}

maven.pom {
    name = 'custom name'
    scm {
      url = "http://custom.url/"
    }
}

And the resulted pom will contain:

<pom>
    <name>custom name</name>
    <description>desc</description>
    <scm>
        <connection>scm:svn:http://subversion.example.com/svn/project/trunk/</connection>
        <url>http://custom.url/</url>            
    </scm>
</pom>

(and, of course, fixed dependencies)

Multi-module projects

BOM options

In order to unify dependencies management in multi-module project you'll have to use something like BOM (all versions in one place, modules just declare what they use).

There are two ways to declare BOMs with gradle:

spring's dependency-management plugin
gradle's java-platform plugin

From my experience gradle platforms works much better. There is a major drawback: gradle platform will not allow you to declare dependency exclusions. It is a surprise for maven users, but you'll have to change your mind and apply required exclusions only in target module (where you apply dependency).

You can read more about gradle native BOMs support in this article (for an overview)

There are also some differences in boms import behaviour: spring plugin will behave exactly as maven. You can read more: why spring plugin is still useful.

Major drawback for spring plugin is: it applies bom to all configurations (yes, it's possible to apply only to some, but also cause other problems). For example, I often see spotbugs plugin affected, because it uses custom configuration which could be ruined by the bom imported into project (and so I have to manually force all required versions there).

For simple cases always prefer gradle native support. For complex cases, try to use platform too and go to spring plugin only if you can't avoid it. Don't get me wrong, spring plugin is very good, but you'll have much fewer problems with platforms.

Example BOM publication

Here is an example of multi-module project where:

All dependencies declared in the root project with java-platform (maven way!)
Root project published as BOM (not canonical BOM: contains all dependencies and all project modules; this way allows including other boms and optional dependencies - simpler to use)
All subprojects are java projects. All depend on platform, declared in root, but platform is removed from generated pom (to avoid bom delcare module, which again use bom for dependencies resolution)

plugins {
    id 'java-platform'
    id 'ru.vyarus.pom'
}

javaPlatform {
    allowDependencies()
}

// root project is a BOM, published as 'module-bom' artifact
// Here must be all dependency versions, used by all modules
dependencies {
    // import other BOMs
    api platform('ru.vyarus.guicey:guicey-bom:5.2.0-1')
    // dependencies
    constraints {
        api 'org.webjars:webjars-locator:0.40'
    }

    // add subprojects to BOM
    project.subprojects.each {
        api it
    }
}

// without it root project's name and description would be used
maven.pom {
    name = 'test-bom'
    description = 'Test project BOM'
}

publishing {
    publications {
        bom(MavenPublication) {
            // artifact name required for published artifact instead of root project name
            artifactId = 'test-bom'
            from components.javaPlatform
        }
    }
}

// maven pom related configuration applied to all projects (including root)
allprojects {
    
    repositories { mavenCentral(); mavenLocal() }

    group = 'com.sample'
    
    // general pom info, required for all poms (including BOM)

    // such delay is required because java-lib (and java) plugin would be applied only
    // in the subprojects section and so this would configure root project configuration
    // without delay
    plugins.withId('java') {
        maven.pom {
            developers {
                developer {
                    id = 'johnd'
                    name = 'John Doe'
                    email = '[email protected]'
                }
            }
        }
    }

    // disable gradle metadata publishing (because it confuse and cause problems)
    tasks.withType(GenerateModuleMetadata).configureEach {
        enabled = false
    }
}

// all sub-modules are java normal modules, using root project as bom
subprojects {
    apply plugin: 'java'
    apply plugin: 'ru.vyarus.pom'
    
    sourceCompatibility = 1.8

    // common dependencies for all modules
    dependencies {
        // use versions declared in the root module
        implementation platform(project(':'))

        compileOnly 'com.github.spotbugs:spotbugs-annotations:4.2.3'
        implementation 'org.slf4j:slf4j-api'
    }

    // use only direct dependencies in the generated pom, removing BOM
    maven {
        removeDependencyManagement()
    }
 
    publishing {
        publications {
            mavenJava(MavenPublication) {
                from components.java
            }
        }
    }
}

Suppose there are one module (settings.gradle):

include 'test'

In that module we ony declare required dependencies:

dependencies {
    implementation 'org.webjars:webjars-locator'
}

Now if we generate poms (generatePomFileForBomPublication and generatePomFileForMavenPublication) the root project's bom would be (com.sample:test-bom artifact):

<dependencyManagement>
    <dependencies>
        <!-- constraints -->
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>webjars-locator</artifactId>
            <version>0.40</version>
        </dependency>
        <!-- imported BOM -->
        <dependency>
            <groupId>ru.vyarus.guicey</groupId>
            <artifactId>guicey-bom</artifactId>
            <version>5.2.0-1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- module -->
        <dependency>
            <groupId>com.sample</groupId>
            <artifactId>test</artifactId>
            <version>1.0</version>
        </dependency>
    </dependencies>
</dependencyManagement>

And pom for modules (com.sample:test artifact):

<dependencies>
    <!-- compileOnly dependency does not appear here -->
    <!-- dependency declared for all modules -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
        <scope>compile</scope>
    </dependency>
    <!-- dependency declared in module -->
    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>webjars-locator</artifactId>
        <version>0.40</version>
    </dependency>
</dependencies>

(alternatively, publishToMavenLocal could be used to look generated artifacts in local maven repo)

The complete multi-module project example could be generated with java-library generator.

Debug

Plugin could print all xml changes to simplify debugging.

To enable debug:

maven {
    debug()
}

For example, enabling debug for a build like this:

plugins {
    id 'java'
    id 'ru.vyarus.pom'
}

group 'ru.vyarus'
version 1.0
description 'sample description'

dependencies {                                         
    // compile
    implementation 'org.javassist:javassist:3.16.1-GA'         
    provided 'com.google.code.findbugs:annotations:3.0.0'
    // runtime
    runtimeOnly 'ru.vyarus:guice-ext-annotations:1.1.1'  
    optional 'ru.vyarus:generics-resolver:2.0.0'
    // disappear    
    compileOnly 'junit:junit:4.12'
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
        }
    }
}    

maven {
    debug()

    pom {
        developers {
            developer {
                id = "dev"
                name = "Dev Dev"
                email = "[email protected]"
            }
        }
    }

    withPom {
        scm {
            url 'http://sdsds.dd'
        }
    }


    withPomXml {
        asNode().appendNode('inceptionYear', 2020)
    }
}

Would print:

> Configure project :
POM> Apply 1 pom model customizations for maven publication

POM> --------------------------------- Applied XML model changes for maven publication
	  10 |   <artifactId>spock_Check_pom_modificat_0_testProjectDir16654992632092536392</artifactId>
	  11 |   <version>1.0</version>
	  12 | +  <developers>+
	  13 | +    <developer>+
	  14 | +      <id>dev</id>+
	  15 | +      <name>Dev Dev</name>+
	  16 | +      <email>[email protected]</email>+
	  17 | +    </developer>+
	  18 | +  </developers>+
     --------------------------------

> Task :generatePomFileForMavenPublication
POM> Correct compile dependencies for maven publication
	 - org.javassist:javassist:3.16.1-GA (original scope: runtime)
	 - com.google.code.findbugs:annotations:3.0.0 (original scope: runtime)
	 - ru.vyarus:generics-resolver:2.0.0 (original scope: runtime)

POM> Correct optional dependencies for maven publication
	 - ru.vyarus:generics-resolver:2.0.0 (original scope: compile)

POM> Correct provided dependencies for maven publication
	 - com.google.code.findbugs:annotations:3.0.0 (original scope: compile)

POM> Apply 1 withXml closures for maven publication
POM> Apply 1 withPomXml customizations for maven publication
POM> Apply default name for maven publication
POM> Apply default description for maven publication

POM> --------------------------------- Applied direct XML changes for maven publication
	  16 |       <artifactId>javassist</artifactId>
	  17 |       <version>3.16.1-GA</version>
	  18 |       -<scope>runtime<-+<scope>compile<+/scope>
	
	  22 |       <artifactId>annotations</artifactId>
	  23 |       <version>3.0.0</version>
	  24 |       -<scope>runtime<-+<scope>provided<+/scope>
	
	  28 |       <artifactId>generics-resolver</artifactId>
	  29 |       <version>2.0.0</version>
	  30 |       -<scope>runtime<-+<scope>compile<+/scope>
	  31 | +      <optional>true</optional>+
	
	  38 |     </dependency>
	  39 |   </dependencies>
	  40 | +  <scm>+
	  41 | +    <url>http://sdsds.dd</url>+
	  42 | +  </scm>+
	  43 | +  <inceptionYear>2020</inceptionYear>+
	  44 | +  <name>spock_Check_pom_modificat_0_testProjectDir16654992632092536392</name>+
	  45 | +  <description>sample description</description>+
     --------------------------------

NOTE: changes for pom block (first xml diff) would be shown only starting from gradle 8.4

Xml changes declared directly in publication are not tracked (couldn't be)!

Migration from 2.x to 3

The plugin was initially created when maven-publish provides just withXml method for manual xml manipulation and so plugin used pure closure (like legacy maven plugin did).

Nowadays, maven-publish provides type-safe pom declaration and pom plugin is now using it directly (so it's finally usable for kotlin too).

BEFORE (2.x):

pom {
    developers {
        developer {
            id "dev"
            name "Dev Dev"
            email "[email protected]"
        }
    } 
}

withPomXml {
    appendNode('description', 'A demonstration of maven POM customization') 
}

pomGeneration {
    forceVersions() 
}

NOW (3):

// pomGeneration renamed to maven  
maven {
    forceVersions()

    // pom moved to maven and renamed to withPom
    withPom {
        developers {
            developer {
                id "dev"
                name "Dev Dev"
                email "[email protected]"
            }
        }
    }

    // withPomXml moved inside maven and it is an Action<XMLProvider> now!
    withPomXml {
        asNode().appendNode('description', 'A demonstration of maven POM customization')
    }
}

The example above is exactly equivalent. But it is recommended to move into static pom declaration (same as in maven-publish plugin), so config above becomes:

maven {
    forceVersions()

    // withPom was a groovy Closure and pom is an Action for static pom configuration
    pom {
        developers {
            developer {
                id = "dev"
                name = "Dev Dev"
                email = "[email protected]"
            }
        }
    }
    
    withPomXml {
        asNode().appendNode('description', 'A demonstration of maven POM customization')
    }
}

NOTE that in pom section all assignments MUST use '='. For more examples see gradle doc.

Might also like

quality-plugin - java and groovy source quality checks
animalsniffer-plugin - java compatibility checks
mkdocs-plugin - project documentation generator

Name		Name	Last commit message	Last commit date
Latest commit History 286 Commits
.github		.github
gradle/wrapper		gradle/wrapper
src		src
.appveyor.yml		.appveyor.yml
.gitignore		.gitignore
.yo-rc.json		.yo-rc.json
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
build.gradle		build.gradle
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Gradle POM plugin

About

Summary

Setup

Compatibility

Snapshots

Usage

Dependencies

Provided dependencies

compileOnly

Make other scopes as provided

War plugin

Optional dependencies

Feature variants

Pom configuration

Non-standard pom tags

Duplicate xml sections detection

Clashed tag names

Defaults

Testing

Manual pom modification

Pom configurations order

Pom generation options

Improving BOMs usage

Gradle pom dsl

Multi-module projects

BOM options

Example BOM publication

Debug

Migration from 2.x to 3

Might also like

About

Releases 14

Packages

Contributors 2

Languages

License

xvik/gradle-pom-plugin

Folders and files

Latest commit

History

Repository files navigation

Gradle POM plugin

About

Summary

Setup

Compatibility

Snapshots

Usage

Dependencies

Provided dependencies

compileOnly

Make other scopes as provided

War plugin

Optional dependencies

Feature variants

Pom configuration

Non-standard pom tags

Duplicate xml sections detection

Clashed tag names

Defaults

Testing

Manual pom modification

Pom configurations order

Pom generation options

Improving BOMs usage

Gradle pom dsl

Multi-module projects

BOM options

Example BOM publication

Debug

Migration from 2.x to 3

Might also like

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 14

Packages 0

Contributors 2

Languages

Packages