Skip to content

Latest commit

 

History

History
265 lines (238 loc) · 7.58 KB

README.md

File metadata and controls

265 lines (238 loc) · 7.58 KB
Raw

Groot, Gradle's good friend! :)

So, what is Groot actually? Groot is set of Gradle plugins. It will allow you easily to setup your project for building and it's maven deployment configuration.

What plugins does it have?

Groot comes with the following plugins:

  • groot
  • groot-java
  • groot-kotlin
  • groot-groovy
  • groot-scala
  • groot-credentials
  • groot-android-library
  • groot-android-application

We currently support the following:

  • Java
  • Kotlin
  • Groovy
  • Scala
  • Android.

How to use it?

To use Groot first you have to add it to your dependencies. Then, depending of your needs you setup your build gradle configuration for your current module. Module may be application module or library module.

To use Groot follow this example:

  • Apply Groot plugins:
apply plugin: "groot"
apply plugin: "groot-kotlin"
apply plugin: "groot-credentials"

If your target language is something else, like Java for example, use:

apply plugin: "groot-java"

instead of:

apply plugin: "groot-kotlin"

NOTE: In that case instead of accessing to groot members through:

groot.kotlin ...

access them through:

groot.java ....
  • If you have Maven repositories on which you already published some of your dependencies you can register it to Groot:
groot.registerRepository("http://repo.milosvasic.net/releases")
groot.registerRepository("http://repo.milosvasic.net/development")
  • Register dependencies that exist on these repositories:
groot.depend("net.milosvasic.logger", "Logger", "1.2.0")
groot.depend("net.milosvasic.factory", "ProjectFactory", "1.0.0_Alpha_1_DEV_+")
  • Configure your module:
final alpha = 1
final beta = 0
final version = 1
final secondaryVersion = 0
final tertiaryVersion = 0
final projectPackage = "groot"
final projectGroup = "net.milosvasic.tryout"

groot.kotlin.project.setup(
        alpha,
        beta,
        version,
        secondaryVersion,
        tertiaryVersion,
        projectGroup,
        projectPackage
)
  • If your project is application setup it too:
String fullPackage = groot.kotlin.project.projectPackage
String fullVersion = groot.kotlin.project.projectVersion

groot.kotlin.application.setup(fullPackage)
  • To deploy your project it is needed to provide access to FTP server where builds will be released:
groot.deployment.ftp.host = ftpServer
groot.deployment.ftp.username = ftpUsername
groot.deployment.ftp.password = ftpPassword
groot.deployment.setup(fullPackage, fullVersion)

Plugin groot-credentials will create credentials files for your release configurations. These credentials files should be git ignored. Groot expect to find them in your module directory. If they do not exist default ones will be created. For example, you may have the following credentials files:

credentials.gradle
credentials_development.gradle
credentials_production.gradle
credentials_something_else.gradle

Kotlin

To use groot-kotlin plugin it is needed to add the following to your build script before apply:

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.1.0"
        classpath "org.jetbrains.kotlin:kotlin-reflect:1.1.0"
    }
}

and to override Kotlin version do the following:

groot.kotlin.version = "1.1.0"

NOTE: Take a look at tryout examples repo.

Groovy

To override Groovy version do the following:

groot.groovy.version = "2.4.7"

NOTE: Take a look at tryout examples repo.

Scala

To override Scala versions do the following:

groot.scala.version = "2.11.1"
groot.scala.testVersion = "3.0.1"

NOTE: Take a look at tryout examples repo.

Android

To use Groot Android plugins it is needed to add Android dependencies to your build script before apply:

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:2.3.0"
    }
}

NOTE: Take a look at tryout examples repo.

Apply android plugin(s):

apply plugin: "groot-android-library"

or

apply plugin: "groot-android-application"

Android provides it's default BuildConfig class.

Defining build variants (Default build variants debug and release are already supported):

groot.android.project.setupBuildVariant("qa", true) // True, False means with or without Proguard enabled.
groot.android.project.setupBuildVariant("staging")  // Without Proguard.

Defining flavors:

groot.android.project.setupFlavor("checking") // Some random flavors
groot.android.project.setupFlavor("releasing")
groot.android.project.setupFlavor("evil")
groot.android.project.setupFlavor("payments")

NOTE: Groot variant and deploy parameters may be used along with Android's variant feature. For more information about Groot variants see next chapter: 'How to build and publish?'.

Sign release build variant for each flavor:

groot.android.project.sign(
        [
                jksFile      : "Signing/Signing.jks",
                storePassword: "Test123",
                keyAlias     : "testKey",
                keyPassword  : "Test123"
        ]
)

Proguard:

To use proguard you have to define proguard-rules.pro in your module's directory. This configuration will be applied to:

  • release build variant
  • to all build variants defined like this one:
groot.android.project.setupBuildVariant("something", true)

NOTE: proguard-rules.pro file is mandatory! If you want to disable it (for your release build type) do this:

groot.android.project.setup(
        alpha,
        beta,
        version,
        secondaryVersion,
        tertiaryVersion,
        projectGroup,
        projectPackage,
        false // We will disable proguard!
)

How to build and publish?

Standard building with publishing will be done like this:

./gradlew clean
./gradlew assemble

Groot will look for credentials.gradle file to perform FTP upload to your Maven repository. If we try this:

./gradlew -Pdeploy=production assemble

Groot will look for credentials_production.gradle and read FTP account information.

Build variants

Default Groot build variant is DEV. Production variant is RELEASE. Every time we build new DEV released is created and published using your publishing configuration defined in credentials.gradle.

If your other project expects latest DEV release you can depend on it like in this example:

groot.registerRepository("http://repo.milosvasic.net/development")
groot.depend("net.milosvasic.factory", "ProjectFactory", "1.0.0_Alpha_1_DEV_+")

To build other variant do this:

./gradlew -Pvariant=RELEASE assemble

or something like:

./gradlew -Pvariant=STAGING assemble

And finally, let's say you wish to build RELEASE variant and release it to production Maven repository:

./gradlew -Pvariant=RELEASE -Pdeploy=production assemble

Build config class

Each module we build with Groot generates BuildConfig class for language used. Build config class contains information about module name, version, groot build variant. In Java for example we have BuildConfig.java, in Kotlin BuildKotlin.kt, in Groovy BuildConfig.groovy and so on. Android provides it's version of BuildConfig with addition of groot build variant.

Tryouts

You can find Groot tryout examples in https://github.com/milos85vasic/Groot-Tryouts. Each module has a purpose to check if Groot is providing everything needed to build properly.