An open API service indexing awesome lists of open source software.

https://github.com/rsocket/gradle-nebula-plugin-rsocket


https://github.com/rsocket/gradle-nebula-plugin-rsocket

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README

          

gradle-nebula-plugin-rsocket
==============

This plugin is to support projects in the RSocket org (and it isn't meant to be used elsewhere). It is at its essence
just a combination of other plugins that are common to all RSocket projects, with some additional configuration. The
primary responsibilities to:

* Provide release process
* Configure publishing
* Recommend license headers
* Create a performance module for testing with jmh
* Configure modules to be as OSGI modules
* Set defaults for javadoc formatting

This project could be used as an example of how a "project plugin" could work. A "project plugin" is a Gradle that
provides consistency across many projects, e.g. in a Github org or an enterprise.

# Build & Binaries

# Plugins Used

For reference, these are Gradle-related modules used:

* com.netflix.nebula:nebula-project-plugin
* com.netflix.nebula:nebula-bintray-plugin' wraps gradle-bintray-plugin with different defaults and adding OJO support and multi-module support.
* com.netflix.nebula:nebula-publishing-plugin for producing a jar, source jar, javadoc jar with metadata about how it was produced.
* com.github.jengelman.gradle.plugins:shadow for generating a binary for the performances tests to run from.
* nl.javadude.gradle.plugins:license-gradle-plugin for license recommendations
* org.ajoberstar:gradle-git:0.9.0 for release process.
* com.netflix.nebula:nebula-test for Gradle integration tests.

# Applying the Plugin

To include, add the following to your build.gradle

buildscript {
repositories { jcenter() }
dependencies { classpath 'io.rsocket:gradle-nebula-plugin-rsocket:1.0.6' }
}

allprojects {
apply plugin: 'rsocket-project'
}

# Parameters

* `-Prelease.travisci=true` - this will disable tagging

# Variants

## License Check

By default the license check is on. To turn it off:

license {
ignoreFailures = true
}