Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 2.95 KB

README.md

File metadata and controls

81 lines (61 loc) · 2.95 KB
Raw

What is it?

A plugin that greatly simplifies publishing of Java/Groovy projects in return for a number of trade-offs.

Assumptions

  • You want to publish only a single artifact per-module
  • You are publishing plain old Java,Groovy or a Gradle plugin
  • You are happy publishing using one of the few supported methods (feel free to add more!)

I want to publish a Java/Groovy library

  • Make sure your projects and modules are named sensibly, as this will determine the artifact names (see below)
  • Apply the plugin
  • Set your version and organisation. The organisation will be used as the first part of the artifact group id and should probably match your package naming for consistency
version = '0.1-SNAPSHOT'
basicPublishing {
    organisation = 'org.foo'
}

You're done! Publish using one of the methods below

What does this give me?

The maven GroupID will default to <organisation>.<root project name> The artifact id will be <project name> So for single module projects your artifact will look something like: org.foo.bar-project:bar-project:1.0 For multi-module projects you'll end up with something like:

org.foo.bar-project:baz-module:1.0
org.foo.bar-project:quz-module:1.0

Publish to maven local

Use the standard gradle task publishToMavenLocal

Publish to a remote maven repository

Add the snapshot and release repository urls, and optionally the username and password if authentication is required. For example:

basicPublishing {
    organisation = 'org.foo'
    
    mavenSnapshotRepository 'http://nexus.myorg.com/nexus/content/repositories/snapshots'
    mavenReleaseRepository 'http://nexus.myorg.com/nexus/content/repositories/releases'
    mavenRepositoryUsername 'deployment'
    mavenRepositoryPassword 'deployment123'
}

You can now call the publish task. This will deploy artifacts to either the snapshot or release repository depending on whether the version ends with "-SNAPSHOT"

Publish to Bintray

  • Create a repository called maven
  • Create your package manually in Bintray. The package name must be set to the root project name
  • Set your bintray username and api key as environment variables BINTRAY_USER and BINTRAY_KEY
  • Use the usual gradle task bintrayUpload

I want to publish a Gradle plugin

  • Add your plugin implementation class to the config. The plugin id will default to <organisation>.<project name>
basicPublishing {
    organisation = 'org.foo'
    pluginImplementationClass = 'org.foo.bar.Baz'
}
  • Adding the pluginImplementationClass will also cause the java-gradle-plugin and com.gradle.plugin-publish plugins to be applied for you
  • No need to create your plugin properties file, it will be generated and included in the plugin jar automatically
  • Set your gradle credentials as environment variables gradlePublishKey and gradlePublishSecret
  • Publish using the usual task publishPlugins