Gradle Maven Plugin

This is a small "plugin" to simplify the use of maven-publish Gradle plugin. You can use this plugin for Java Library and Android Library.

Index

Usage
Customization
Library Publish
Generate POM file

Usage

In order to use GradleMavenizer you have to add the line

apply from: 'https://raw.githubusercontent.com/sky-uk/gradle-maven-plugin/master/gradle-mavenizer.gradle'

at the very bottom of the build.gradle file. Alternatively, to use a specific release version, add this property to the project (see Releases at the top of the Github page for released versions):

mavPluginVersion = '1.0.3'

and add this line to the very bottom of the build.gradle file:

apply from: "https://raw.githubusercontent.com/sky-uk/gradle-maven-plugin/${project.mavPluginVersion}/gradle-mavenizer.gradle"`

Customization

GradleMavenizer is highly customizable.

You can customize it adding some properties to the root project build.gradle or to the module build.gradle file.

Attention: If you add the same property to the root project file and to the module file, in order of priority, the module file property will override the root project property.

1. Generic Project Info (included in POM)

mavProjectName -> String property -> Identify the project name (can be different from the artifactId)
mavLibraryDescription -> String property -> A simple description for the library
mavDevelopers -> Map property -> A map with the ids, name, and the developer email of the library
mavLibraryLicenses -> Map property -> A map with the name and the urls of the library licenses
mavSiteUrl -> String property -> Identify the url of the project website
mavGitUrl -> String property ->Identify the url of the project github page

2. Repositories

Remote repository:
- mavPublishToRemoteRepo -> Boolean property -> Allow the script to load your library to a remote repo
- mavRemoteRepoUser -> String property -> Username to grant access to the remote repo
- mavRemoteRepoPassword -> String property -> Password to grant access to the remote repo
- mavRepoRemoteUrl -> String property -> Identify the url of the remote repo
Github Packages:
- mavPublishToGithubPackages -> Boolean property -> Allow the script to load your library to a Github Packages
- mavGithubPackagesUser -> String property -> Your Github username
- mavGithubPackagesToken -> String property -> Token to grant access to the Github Packages
- mavGithubPackagesUrl -> String property -> Identify the url of the Github Packages
Internal repository:
- mavPublishToInternalRepo -> Boolean property -> Allow the script to load your library to an internal repo
- mavRepoInternalUrl -> String property -> Identify the url of the internal repo
MavenLocal repository:
- mavPublishToMavenLocal -> Boolean property -> Allow the script to load your library to MavenLocal folder

Attention: If you won't set any repository automatically the script will use MavenLocal as default repo

Example of per-module build.gradle costumization

project.ext {
    mavDevelopers = ["Fe":["Federico", "frederico@gmail.com"]]
    mavSiteUrl = "https://github.com/sky-uk/gradle-maven-plugin"
    mavGitUrl = mavSiteUrl + '.git'
    mavProjectName = 'GradleMavenizer'
    mavPublishToInternalRepo = true
    mavRepoInternalUrl = "path/to/internal/repo"
    mavLibraryLicenses = ["Apache-2.0":'http://www.apache.org/licenses/LICENSE-2.0.txt']
    mavLibraryDescription = "A simple description of the project"
}

It is possible to add more developers, example:

mavDevelopers = ["userId1":["User 1", "user1@gmail.com"],["userId2":["User 2", "user2@gmail.com"]]

Library Publish

To finally publish you library you can use the command ./gradlew publish directly from your project root folder.

You can also pass some properties directly from command line using the command -P (every property must have -P before), for example: ./gradlew publish -PmavPublishToMavenLocal=true

Generate POM file

If you want to generate the POM file without publish your library you can use the command ./gradlew generatePomFileForMavenPublishPublication directly from your project root folder.

To generate the POM file only for one module of your library you can use the command ./gradlew your-module-name:generatePomFileForMavenPublishPublication where you have to replace your-module-name with the name you chose for your module.

Note: POM file will be saved in build/publications/mavenPublish/ as pom-default.xml

onimur / gradle-maven-plugin